-
Notifications
You must be signed in to change notification settings - Fork 4k
/
articles_spec.rb
1262 lines (1061 loc) · 49.5 KB
/
articles_spec.rb
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
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
require "rails_helper"
RSpec.describe "Api::V0::Articles" do
let(:organization) { create(:organization) } # not used by every spec but lower times overall
let(:tag) { create(:tag, name: "discuss") }
let(:article) { create(:article, featured: true, tags: "discuss") }
let(:new_article) { create(:article) }
before { stub_const("FlareTag::FLARE_TAG_IDS_HASH", { "discuss" => tag.id }) }
describe "GET /api/articles" do
before { article }
it "returns CORS headers" do
origin = "http://example.com"
get api_articles_path, headers: { origin: origin }
expect(response).to have_http_status(:ok)
expect(response.headers["Access-Control-Allow-Origin"]).to eq(origin)
expect(response.headers["Access-Control-Allow-Methods"]).to eq("HEAD, GET, OPTIONS")
expect(response.headers["Access-Control-Expose-Headers"]).to be_empty
expect(response.headers["Access-Control-Max-Age"]).to eq(2.hours.to_i.to_s)
end
it "has correct keys in the response" do
article.update_columns(organization_id: organization.id)
get api_articles_path
index_keys = %w[
type_of id title description cover_image readable_publish_date social_image
tag_list tags slug path url canonical_url comments_count public_reactions_count positive_reactions_count
collection_id created_at edited_at crossposted_at published_at last_comment_at
published_timestamp user organization flare_tag reading_time_minutes
]
expect(response.parsed_body.first.keys).to match_array index_keys
end
it "returns correct tag list" do
get api_articles_path
expect(response.parsed_body.first["tag_list"]).to be_a Array
end
it "returns correct tags" do
get api_articles_path
expect(response.parsed_body.first["tags"]).to be_a String
end
context "without params" do
it "returns json response" do
get api_articles_path
expect(response.media_type).to eq("application/json")
end
it "returns nothing if params state=all is not found" do
get api_articles_path(state: "all")
expect(response.parsed_body.size).to eq(0)
end
it "returns featured articles if no param is given" do
article.update_column(:featured, true)
get api_articles_path
expect(response.parsed_body.size).to eq(1)
end
it "supports pagination" do
create_list(:article, 2, featured: true)
get api_articles_path, params: { page: 1, per_page: 2 }
expect(response.parsed_body.length).to eq(2)
get api_articles_path, params: { page: 2, per_page: 2 }
expect(response.parsed_body.length).to eq(1)
end
it "returns flare tag in the response" do
get api_articles_path
response_article = response.parsed_body.first
expect(response_article["flare_tag"]).to be_present
expect(response_article["flare_tag"].keys).to eq(%w[name bg_color_hex text_color_hex])
expect(response_article["flare_tag"]["name"]).to eq("discuss")
end
it "sets the correct edge caching surrogate key" do
get api_articles_path
expected_key = ["articles", article.record_key].to_set
expect(response.headers["surrogate-key"].split.to_set).to eq(expected_key)
end
end
context "with username param" do
it "returns user's articles for the given username" do
create(:article, user: article.user)
get api_articles_path(username: article.user.username)
expect(response.parsed_body.size).to eq(2)
end
it "returns nothing if given user is not found" do
get api_articles_path(username: "foobar")
expect(response.parsed_body.size).to eq(0)
end
it "returns org's articles if org's slug is given" do
create(:article, user: article.user, organization: organization)
get api_articles_path(username: organization.slug)
expect(response.parsed_body.size).to eq(1)
end
it "supports pagination" do
create_list(:article, 2, user: article.user)
get api_articles_path(username: article.user.username), params: { page: 1, per_page: 2 }
expect(response.parsed_body.length).to eq(2)
get api_articles_path(username: article.user.username), params: { page: 2, per_page: 2 }
expect(response.parsed_body.length).to eq(1)
end
it "sets the correct edge caching surrogate key" do
new_article = create(:article, user: article.user)
get api_articles_path(username: article.user.username)
expected_key = ["articles", article.record_key, new_article.record_key].to_set
expect(response.headers["surrogate-key"].split.to_set).to eq(expected_key)
end
end
context "with tag param" do
it "returns tag's articles" do
get api_articles_path(tag: article.tag_list.first)
expect(response.parsed_body.size).to eq(1)
end
it "returns top tag articles if tag and top param is present" do
get api_articles_path(tag: article.tag_list.first, top: "7")
expect(response.parsed_body.size).to eq(1)
end
it "returns not tag articles if article and tag are not approved" do
article.update_column(:approved, false)
tag = Tag.find_by(name: article.tag_list.first)
tag.update(requires_approval: true)
get api_articles_path(tag: tag.name)
expect(response.parsed_body.size).to eq(0)
end
it "supports pagination" do
create_list(:article, 2, tags: "discuss")
get api_articles_path(tag: article.tag_list.first), params: { page: 1, per_page: 2 }
expect(response.parsed_body.length).to eq(2)
get api_articles_path(tag: article.tag_list.first), params: { page: 2, per_page: 2 }
expect(response.parsed_body.length).to eq(1)
end
it "sets the correct edge caching surrogate key" do
get api_articles_path(tag: article.tag_list.first)
expected_key = ["articles", article.record_key].to_set
expect(response.headers["surrogate-key"].split.to_set).to eq(expected_key)
end
end
context "with tags param" do
it "returns articles with any of the specified tags" do
create(:article, published: true)
get api_articles_path(tags: "javascript, css, not-existing-tag")
expect(response.parsed_body.size).to eq(1)
end
end
context "with tags_exclude param" do
it "returns articles that do not contain any of excluded tag" do
create(:article, published: true)
get api_articles_path(tags_exclude: "node, java")
expect(response.parsed_body.size).to eq(2)
create(:article, published: true, tags: "node")
get api_articles_path(tags_exclude: "node, java")
expect(response.parsed_body.size).to eq(2)
end
end
context "with tags and tags_exclude params" do
it "returns proper scope" do
create(:article, published: true)
get api_articles_path(tags: "javascript, css", tags_exclude: "node, java")
expect(response.parsed_body.size).to eq(1)
end
end
context "when tags and tags_exclude contain the same tag" do
it "returns empty set" do
create(:article, published: true, tags: "java")
get api_articles_path(tags: "java", tags_exclude: "java")
expect(response.parsed_body.size).to eq(0)
end
end
context "with top param" do
it "only returns fresh top articles if top param is present" do
# TODO: slight duplication, test should be removed
old_article = create(:article)
old_article.update_column(:published_at, 10.days.ago)
get api_articles_path(top: "7")
expect(response.parsed_body.size).to eq(1)
end
it "supports pagination" do
old_articles = create_list(:article, 2, featured: true)
old_articles.each do |old_article|
old_article.update_column(:published_at, 10.days.ago)
end
get api_articles_path(top: "11"), params: { page: 1, per_page: 2 }
expect(response.parsed_body.length).to eq(2)
get api_articles_path(top: "11"), params: { page: 2, per_page: 2 }
expect(response.parsed_body.length).to eq(1)
end
it "sets the correct edge caching surrogate key" do
get api_articles_path(top: "7")
expected_key = ["articles", article.record_key].to_set
expect(response.headers["surrogate-key"].split.to_set).to eq(expected_key)
end
end
context "with collection_id param" do
it "returns a collection id" do
collection = create(:collection, user: article.user)
article.update_columns(collection_id: collection.id)
get api_articles_path(collection_id: collection.id)
expect(response.parsed_body[0]["collection_id"]).to eq collection.id
end
it "supports pagination" do
collection = create(:collection, user: article.user)
article.update_columns(collection_id: collection.id)
collection_articles = create_list(:article, 2, featured: true)
collection_articles.each do |collection_article|
collection_article.update_columns(collection_id: collection.id)
end
get api_articles_path(collection_id: collection.id), params: { page: 1, per_page: 2 }
expect(response.parsed_body.length).to eq(2)
get api_articles_path(collection_id: collection.id), params: { page: 2, per_page: 2 }
expect(response.parsed_body.length).to eq(1)
end
it "sets the correct edge caching surrogate key" do
collection = create(:collection, user: article.user)
article.update_columns(collection_id: collection.id)
get api_articles_path(collection_id: collection.id)
expected_key = ["articles", article.record_key].to_set
expect(response.headers["surrogate-key"].split.to_set).to eq(expected_key)
end
end
context "with state param" do
it "returns fresh articles" do
article.update_columns(public_reactions_count: 1, score: 1)
get api_articles_path(state: "fresh")
expect(response.parsed_body.size).to eq(1)
end
it "returns rising articles" do
article.update_columns(public_reactions_count: 32, score: 1, published_at: 2.days.ago)
get api_articles_path(state: "rising")
expect(response.parsed_body.size).to eq(1)
end
it "returns articles sorted by publish date" do
article.update_columns(published_at: 500.years.ago)
new_article.update_columns(published_at: 1.minute.ago)
get latest_api_articles_path
first_article_published_at = response.parsed_body.first["published_at"]
last_article_published_at = response.parsed_body.last["published_at"]
expect(first_article_published_at.to_date).to be > last_article_published_at.to_date
end
it "returns nothing if the state is unknown" do
get api_articles_path(state: "foobar")
expect(response.parsed_body).to be_empty
end
it "supports pagination" do
create_list(:article, 2, tags: "discuss", public_reactions_count: 1, score: 1)
get api_articles_path(state: "fresh"), params: { page: 1, per_page: 2 }
expect(response.parsed_body.length).to eq(2)
get api_articles_path(state: "fresh"), params: { page: 2, per_page: 2 }
expect(response.parsed_body.length).to eq(1)
end
it "sets the correct edge caching surrogate key" do
article.update_columns(public_reactions_count: 1, score: 1)
get api_articles_path(state: "fresh")
expected_key = ["articles", article.record_key].to_set
expect(response.headers["surrogate-key"].split.to_set).to eq(expected_key)
end
end
context "with regression tests" do
it "works if both the social image and the main image are missing" do
article.update_columns(social_image: nil, main_image: nil)
get api_articles_path
expect(response).to have_http_status(:ok)
end
it "respects API_PER_PAGE_MAX limit set in ENV variable" do
allow(ApplicationConfig).to receive(:[]).and_return(nil)
allow(ApplicationConfig).to receive(:[]).with("APP_PROTOCOL").and_return("http://")
allow(ApplicationConfig).to receive(:[]).with("API_PER_PAGE_MAX").and_return(2)
create_list(:article, 3, tags: "discuss", public_reactions_count: 1, score: 1, published: true, featured: true)
get api_articles_path, params: { per_page: 10 }
expect(response.parsed_body.count).to eq(2)
end
end
end
describe "GET /api/articles/:id" do
it "returns CORS headers" do
origin = "http://example.com"
get api_article_path(article.id), headers: { origin: origin }
expect(response).to have_http_status(:ok)
expect(response.headers["Access-Control-Allow-Origin"]).to eq(origin)
expect(response.headers["Access-Control-Allow-Methods"]).to eq("HEAD, GET, OPTIONS")
expect(response.headers["Access-Control-Expose-Headers"]).to be_empty
expect(response.headers["Access-Control-Max-Age"]).to eq(2.hours.to_i.to_s)
end
it "has correct keys in the response" do
article.update_columns(organization_id: organization.id)
get api_article_path(article.id)
show_keys = %w[
type_of id title description cover_image readable_publish_date social_image
tag_list tags slug path url canonical_url comments_count public_reactions_count positive_reactions_count
collection_id created_at edited_at crossposted_at published_at last_comment_at
published_timestamp body_html body_markdown user organization flare_tag reading_time_minutes
]
expect(response.parsed_body.keys).to match_array show_keys
end
it "returns correct tag list" do
get api_article_path(article.id)
expect(response.parsed_body["tag_list"]).to be_a String
end
it "returns correct tags" do
get api_article_path(article.id)
expect(response.parsed_body["tags"]).to be_a Array
end
it "returns proper article" do
get api_article_path(article.id)
expect(response.parsed_body).to include(
"title" => article.title,
"body_markdown" => article.body_markdown,
"tags" => article.decorate.cached_tag_list_array,
)
end
it "returns all the relevant datetimes" do
article.update_columns(
edited_at: 1.minute.from_now, crossposted_at: 2.minutes.ago, last_comment_at: 30.seconds.ago,
)
get api_article_path(article.id)
expect(response.parsed_body).to include(
"created_at" => article.created_at.utc.iso8601,
"edited_at" => article.edited_at.utc.iso8601,
"crossposted_at" => article.crossposted_at.utc.iso8601,
"published_at" => article.published_at.utc.iso8601,
"last_comment_at" => article.last_comment_at.utc.iso8601,
)
end
it "fails with an unpublished article" do
article.update_columns(published: false, published_at: nil)
get api_article_path(article.id)
expect(response).to have_http_status(:not_found)
end
it "fails with an unknown article ID" do
get api_article_path("9999")
expect(response).to have_http_status(:not_found)
end
it "sets the correct edge caching surrogate key" do
get api_article_path(article)
expected_key = [article.record_key].to_set
expect(response.headers["surrogate-key"].split.to_set).to eq(expected_key)
end
end
describe "GET /api/articles/:username/:slug" do
it "returns CORS headers" do
origin = "http://example.com"
get "/api/articles/#{article.username}/#{article.slug}", headers: { origin: origin }
expect(response).to have_http_status(:ok)
expect(response.headers["Access-Control-Allow-Origin"]).to eq(origin)
expect(response.headers["Access-Control-Allow-Methods"]).to eq("HEAD, GET, OPTIONS")
expect(response.headers["Access-Control-Expose-Headers"]).to be_empty
expect(response.headers["Access-Control-Max-Age"]).to eq(2.hours.to_i.to_s)
end
it "returns correct tags" do
get "/api/articles/#{article.username}/#{article.slug}"
expect(response.parsed_body["tags"]).to eq(article.tag_list)
expect(response.parsed_body["tag_list"]).to eq(article.tags[0].name)
end
it "returns proper article" do
get "/api/articles/#{article.username}/#{article.slug}"
expect(response.parsed_body).to include(
"title" => article.title,
"body_markdown" => article.body_markdown,
"tags" => article.decorate.cached_tag_list_array,
)
end
it "returns all the relevant datetimes" do
article.update_columns(
edited_at: 1.minute.from_now, crossposted_at: 2.minutes.ago, last_comment_at: 30.seconds.ago,
)
get "/api/articles/#{article.username}/#{article.slug}"
expect(response.parsed_body).to include(
"created_at" => article.created_at.utc.iso8601,
"edited_at" => article.edited_at.utc.iso8601,
"crossposted_at" => article.crossposted_at.utc.iso8601,
"published_at" => article.published_at.utc.iso8601,
"last_comment_at" => article.last_comment_at.utc.iso8601,
)
end
it "fails with an unpublished article" do
article.update_columns(published: false, published_at: nil)
get "/api/articles/#{article.username}/#{article.slug}"
expect(response).to have_http_status(:not_found)
end
it "fails with an unknown article path" do
get "/api/articles/chrisevans/#{article.slug}"
expect(response).to have_http_status(:not_found)
end
it "sets the correct edge caching surrogate key" do
get "/api/articles/#{article.username}/#{article.slug}"
expected_key = [article.record_key].to_set
expect(response.headers["surrogate-key"].split.to_set).to eq(expected_key)
end
end
describe "GET /api/articles/me(/:status)" do
let(:api_secret) { create(:api_secret, user: user) }
let(:headers) { { "api-key" => api_secret.secret } }
context "when request is unauthenticated" do
let(:user) { create(:user) }
it "return unauthorized" do
get "/api/articles/me"
expect(response).to have_http_status(:unauthorized)
end
end
context "when request is authenticated" do
let(:user) { create(:user) }
it "returns proper response specification" do
get "/api/articles/me", headers: headers
expect(response.media_type).to eq("application/json")
expect(response).to have_http_status(:ok)
end
it "returns success when requesting published articles with public token" do
get "/api/articles/me/published", headers: headers
expect(response.media_type).to eq("application/json")
expect(response).to have_http_status(:ok)
end
it "return only user's articles including markdown" do
create(:article, user: user)
create(:article)
get "/api/articles/me", headers: headers
expect(response.parsed_body.length).to eq(1)
expect(response.parsed_body[0]["body_markdown"]).not_to be_nil
end
it "supports pagination" do
create_list(:article, 3, user: user)
get "/api/articles/me", headers: headers, params: { page: 2, per_page: 2 }
expect(response.parsed_body.length).to eq(1)
end
it "has correct keys in the response" do
article = create(:article, user: user)
article.update_columns(organization_id: organization.id)
get "/api/articles/me", headers: headers
keys = %w[
type_of id title description published published_at slug path url
comments_count public_reactions_count page_views_count
published_timestamp body_markdown positive_reactions_count cover_image
tag_list canonical_url reading_time_minutes user organization flare_tag
]
expect(response.parsed_body.first.keys).to match_array(keys)
end
it "only includes published articles by default" do
create(:article, published: false, published_at: nil, user: user)
get "/api/articles/me", headers: headers
expect(response.parsed_body.length).to eq(0)
end
it "only includes published articles when asking for published articles" do
create(:article, published: false, published_at: nil, user: user)
get "/api/articles/me/published", headers: headers
expect(response.parsed_body.length).to eq(0)
end
it "only includes unpublished articles when asking for unpublished articles" do
create(:article, published: false, published_at: nil, user: user)
get "/api/articles/me/unpublished", headers: headers
expect(response.parsed_body.length).to eq(1)
end
it "orders unpublished articles by reverse order when asking for unpublished articles" do
older = create(:article, published: false, published_at: nil, user: user)
newer = nil
Timecop.travel(1.day.from_now) do
newer = create(:article, published: false, published_at: nil, user: user)
end
get "/api/articles/me/unpublished", headers: headers
expected_order = response.parsed_body.map.pluck("id")
expect(expected_order).to eq([newer.id, older.id])
end
it "puts unpublished articles at the top when asking for all articles" do
create(:article, user: user)
create(:article, published: false, published_at: nil, user: user)
get "/api/articles/me/all", headers: headers
expected_order = response.parsed_body.pluck("published")
expect(expected_order).to eq([false, true])
end
it "correctly returns reading time in minutes" do
create(:article, user: user)
get "/api/articles/me", headers: headers
expect(response.parsed_body.first["reading_time_minutes"]).to eq(article.reading_time)
end
end
end
describe "POST /api/articles" do
# As written, it's envisioned that the subject and these "let" statements create a valid
# authentication and authorization.
subject(:the_response) do
# This looks a bit funny, I want to issue the request but test the response. The "post"
# method does not return a "response" object.
post api_articles_path, params: { article: params }.to_json, headers: headers
response
end
let(:api_secret) { create(:api_secret) }
let(:user) { api_secret.user }
let(:headers) { { "api-key" => api_secret.secret, "content-type" => "application/json" } }
let(:params) { {} }
context "when user suspended" do
before { user.add_role(:suspended) }
it { is_expected.to have_http_status(:unauthorized) }
end
context "when no api key provided" do
let(:headers) { { "content-type" => "application/json" } }
it { is_expected.to have_http_status(:unauthorized) }
end
context "when given invalid api key" do
let(:headers) { { "api-key" => "no you're never gonna get it", "content-type" => "application/json" } }
it { is_expected.to have_http_status(:unauthorized) }
end
context "when security comparision fails" do
before { allow(ActiveSupport::SecurityUtils).to receive(:secure_compare).and_return(false) }
it { is_expected.to have_http_status(:unauthorized) }
end
context "when only admins can post to site" do
# [@jeremyf] Part of me loaths the idea of writing this specific policy implementation.
# Another option is to do some "allow_any_instance_of" antics. For now, this is
# the concession, but as we move through further policy changes, I'm uncertain if
# we want our requests to bombard the nuances of policy.
before { allow(ArticlePolicy).to receive(:limit_post_creation_to_admins?).and_return(true) }
it { is_expected.to have_http_status(:unauthorized) }
end
describe "when authorized" do
let(:default_params) { { body_markdown: "" } }
def post_article(**params)
headers = { "api-key" => api_secret.secret, "content-type" => "application/json" }
params = default_params.merge params
post api_articles_path, params: { article: params }.to_json, headers: headers
end
it "returns a 429 status code if the rate limit is reached" do
rate_limit_checker = instance_double(RateLimitChecker)
retry_after_val = RateLimitChecker::ACTION_LIMITERS.dig(:published_article_creation, :retry_after)
rate_limit_error = RateLimitChecker::LimitReached.new(retry_after_val)
allow(RateLimitChecker).to receive(:new).and_return(rate_limit_checker)
allow(rate_limit_checker).to receive(:check_limit!).and_raise(rate_limit_error)
post_article
expect(response).to have_http_status(:too_many_requests)
expect(response.headers["retry-after"]).to eq(retry_after_val)
end
it "fails if no params are given" do
post_article
expect(response).to have_http_status(:unprocessable_entity)
end
it "fails if missing required params" do
tags = %w[meta discussion]
post_article(body_markdown: "Yo ho ho", tags: tags)
expect(response).to have_http_status(:unprocessable_entity)
expect(response.parsed_body["error"]).to be_present
end
it "fails if article contains tags with non-alphanumeric characters" do
tags = %w[#discuss .help]
post_article(title: "Test Article Title", tags: tags)
expect(response).to have_http_status(:unprocessable_entity)
end
it "fails if params are not a Hash" do
# Not using the nifty post_article helper method because it expects a Hash
headers = { "api-key" => api_secret.secret, "content-type" => "application/json" }
string_params = "this_string_is_definitely_not_a_hash"
post api_articles_path, params: { article: string_params }.to_json, headers: headers
expect(response).to have_http_status(:unprocessable_entity)
expect(response.parsed_body["error"]).to be_present
end
it "fails if params are unwrapped" do
headers = { "api-key" => api_secret.secret, "content-type" => "application/json" }
post api_articles_path, params: { body_markdown: "Body", title: "Title" }.to_json, headers: headers
expect(response).to have_http_status(:unprocessable_entity)
expect(response.parsed_body["error"]).to be_present
end
it "creates an article belonging to the user" do
post_article(title: Faker::Book.title)
expect(response).to have_http_status(:created)
expect(Article.find(response.parsed_body["id"]).user).to eq(user)
end
it "creates an unpublished article by default" do
post_article(title: Faker::Book.title)
expect(response).to have_http_status(:created)
expect(Article.find(response.parsed_body["id"]).published).to be(false)
end
it "returns the location of the article" do
post_article(title: Faker::Book.title)
expect(response).to have_http_status(:created)
expect(response.location).not_to be_blank
end
it "creates an article with only a title" do
title = Faker::Book.title
expect do
post_article(title: title)
expect(response).to have_http_status(:created)
end.to change(Article, :count).by(1)
expect(Article.find(response.parsed_body["id"]).title).to eq(title)
end
it "creates a published article" do
title = Faker::Book.title
expect do
post_article(title: title, published: true)
expect(response).to have_http_status(:created)
end.to change(Article, :count).by(1)
expect(Article.find(response.parsed_body["id"]).published).to be(true)
end
it "creates an article with a title and the markdown body" do
body_markdown = "Yo ho ho"
expect do
post_article(
title: Faker::Book.title,
body_markdown: body_markdown,
)
expect(response).to have_http_status(:created)
end.to change(Article, :count).by(1)
expect(Article.find(response.parsed_body["id"]).body_markdown).to eq(body_markdown)
end
it "creates an article with a title, body and a list of tags" do
tags = %w[meta discussion]
expect do
post_article(
title: Faker::Book.title,
body_markdown: "Yo ho ho",
tags: tags,
)
expect(response).to have_http_status(:created)
end.to change(Article, :count).by(1)
expect(Article.find(response.parsed_body["id"]).cached_tag_list).to eq(tags.join(", "))
end
it "creates an unpublished article with the front matter in the body" do
body_markdown = file_fixture("article_unpublished.txt").read
expect do
post_article(body_markdown: body_markdown)
expect(response).to have_http_status(:created)
end.to change(Article, :count).by(1)
article = Article.find(response.parsed_body["id"])
expect(article.title).to eq("Sample Article")
expect(article.published).to be(false)
end
it "creates published article with the front matter in the body" do
body_markdown = file_fixture("article_published.txt").read
expect do
post_article(body_markdown: body_markdown)
expect(response).to have_http_status(:created)
end.to change(Article, :count).by(1)
article = Article.find(response.parsed_body["id"])
expect(article.title).to eq("Sample Article")
expect(article.published).to be(true)
end
it "creates an article within a series" do
series = "a series"
post_article(
title: Faker::Book.title,
body_markdown: "Yo ho ho",
series: series,
)
expect(response).to have_http_status(:created)
article = Article.find(response.parsed_body["id"])
expect(article.collection).to eq(Collection.find_by(slug: series))
expect(article.collection.user).to eq(user)
end
it "creates article within a series using the front matter" do
body_markdown = file_fixture("article_published_series.txt").read
expect do
post_article(body_markdown: body_markdown)
expect(response).to have_http_status(:created)
end.to change(Article, :count).by(1)
article = Article.find(response.parsed_body["id"])
expect(article.collection).to eq(Collection.find_by(slug: "a series"))
expect(article.collection.user).to eq(user)
end
it "creates an article on behalf of an organization" do
organization = create(:organization)
create(:organization_membership, user: user, organization: organization)
expect do
post_article(
title: Faker::Book.title,
organization_id: organization.id,
)
expect(response).to have_http_status(:created)
end.to change(Article, :count).by(1)
expect(Article.find(response.parsed_body["id"]).organization).to eq(organization)
end
it "creates an article with a main/cover image" do
image_url = "https://dummyimage.com/100x100"
expect do
post_article(
title: Faker::Book.title,
body_markdown: "Yo ho ho",
main_image: image_url,
)
expect(response).to have_http_status(:created)
end.to change(Article, :count).by(1)
expect(Article.find(response.parsed_body["id"]).main_image).to eq(image_url)
end
it "creates an article with a main/cover image in the front matter" do
image_url = "https://dummyimage.com/100x100"
body_markdown = file_fixture("article_published_cover_image.txt").read
expect do
post_article(body_markdown: body_markdown)
expect(response).to have_http_status(:created)
end.to change(Article, :count).by(1)
expect(Article.find(response.parsed_body["id"]).main_image).to eq(image_url)
end
it "creates an article with a canonical url" do
canonical_url = "https://example.com/"
expect do
post_article(
title: Faker::Book.title,
body_markdown: "Yo ho ho",
canonical_url: canonical_url,
)
expect(response).to have_http_status(:created)
end.to change(Article, :count).by(1)
expect(Article.find(response.parsed_body["id"]).canonical_url).to eq(canonical_url)
end
it "creates an article with a canonical url in the front matter" do
canonical_url = "https://example.com/"
body_markdown = file_fixture("article_published_canonical_url.txt").read
expect do
post_article(body_markdown: body_markdown)
expect(response).to have_http_status(:created)
end.to change(Article, :count).by(1)
expect(Article.find(response.parsed_body["id"]).canonical_url).to eq(canonical_url)
end
it "creates an article with the given description" do
description = "this is a very interesting article"
expect do
post_article(
title: Faker::Book.title,
body_markdown: "Yo ho ho",
description: description,
)
expect(response).to have_http_status(:created)
end.to change(Article, :count).by(1)
expect(Article.find(response.parsed_body["id"]).description).to eq(description)
end
it "creates an article with description in the front matter" do
description = "this is a very interesting article"
body_markdown = file_fixture("article_published_canonical_url.txt").read
expect do
post_article(
body_markdown: body_markdown,
description: description,
)
expect(response).to have_http_status(:created)
end.to change(Article, :count).by(1)
expect(Article.find(response.parsed_body["id"]).description).not_to eq(description)
end
it "creates an article with a part of the body as a description" do
expect do
post_article(
title: Faker::Book.title,
body_markdown: "yoooo" * 100,
)
expect(response).to have_http_status(:created)
end.to change(Article, :count).by(1)
expect(Article.find(response.parsed_body["id"]).description).to eq("#{'yoooo' * 20}y...")
end
it "does not raise an error if article params are missing" do
headers = { "api-key" => api_secret.secret, "content-type" => "application/json" }
expect do
post api_articles_path, params: {}.to_json, headers: headers
end.not_to raise_error
expect(response).to have_http_status(:unprocessable_entity)
end
it "fails with a nil body markdown" do
post_article(title: Faker::Book.title, body_markdown: nil)
expect(response).to have_http_status(:unprocessable_entity)
expect(response.parsed_body["error"]).to be_present
end
end
end
describe "PUT /api/articles/:id" do
let!(:api_secret) { create(:api_secret) }
let!(:user) { api_secret.user }
let(:article) { create(:article, user: user, published: false, published_at: nil) }
let(:path) { api_article_path(article.id) }
let!(:organization) { create(:organization) }
describe "when unauthorized" do
it "fails with no api key" do
put path, headers: { "content-type" => "application/json" }
expect(response).to have_http_status(:unauthorized)
end
it "fails with the wrong api key" do
put path, headers: { "api-key" => "foobar", "content-type" => "application/json" }
expect(response).to have_http_status(:unauthorized)
end
it "fails with a failing secure compare" do
allow(ActiveSupport::SecurityUtils)
.to receive(:secure_compare).and_return(false)
put path, headers: { "api-key" => api_secret.secret, "content-type" => "application/json" }
expect(response).to have_http_status(:unauthorized)
end
end
describe "when authorized" do
let!(:headers) { { "api-key" => api_secret.secret, "content-type" => "application/json" } }
def put_article(**params)
headers = { "api-key" => api_secret.secret, "content-type" => "application/json" }
put path, params: { article: params }.to_json, headers: headers
end
it "returns a 429 status code if the rate limit is reached" do
rate_limit_checker = instance_double(RateLimitChecker)
retry_after_val = RateLimitChecker::ACTION_LIMITERS.dig(:article_update, :retry_after)
rate_limit_error = RateLimitChecker::LimitReached.new(retry_after_val)
allow(RateLimitChecker).to receive(:new).and_return(rate_limit_checker)
allow(rate_limit_checker).to receive(:check_limit!).and_raise(rate_limit_error)
put_article(title: Faker::Book.title, body_markdown: "foobar")
expect(response).to have_http_status(:too_many_requests)
expect(response.headers["retry-after"]).to eq(retry_after_val)
end
it "returns not found if the article does not belong to the user" do
article = create(:article, user: create(:user))
headers = { "api-key" => api_secret.secret, "content-type" => "application/json" }
params = { article: { title: "foobar" } }.to_json
put "/api/articles/#{article.id}", params: params, headers: headers
expect(response).to have_http_status(:not_found)
end
it "lets a super admin update an article belonging to another user" do
user.add_role(:super_admin)
article = create(:article, user: create(:user))
headers = { "api-key" => api_secret.secret, "content-type" => "application/json" }
params = { article: { title: "foobar" } }.to_json
put "/api/articles/#{article.id}", params: params, headers: headers
expect(response).to have_http_status(:ok)
end
it "does not update title if only given a title because the article has a front matter" do
put_article(title: Faker::Book.title)
expect(response).to have_http_status(:ok)
expect(article.reload.title).to eq(article.title)
expect(response.parsed_body["title"]).to eq(article.title)
end
it "updates the title and the body if given a title and a body" do
title = Faker::Book.title
body_markdown = "foobar"
put_article(title: title, body_markdown: body_markdown)
expect(response).to have_http_status(:ok)
expect(article.reload.title).to eq(title)
expect(article.body_markdown).to eq(body_markdown)
end
it "updates the main_image to be empty if given an empty cover_image" do
image = Faker::Avatar.image
article.update(main_image: image)
expect(article.main_image).to eq(image)
body_markdown = file_fixture("article_published_empty_cover_image.txt").read
put_article(
title: Faker::Book.title,
body_markdown: body_markdown,
)
expect(response).to have_http_status(:ok)
expect(article.reload.main_image).to be_nil
end
it "updates the main_image to be empty if given a different cover_image" do
image = Faker::Avatar.image
article.update(main_image: image)
expect(article.main_image).to eq(image)
body_markdown = file_fixture("article_published_cover_image.txt").read
put_article(
title: Faker::Book.title,
body_markdown: body_markdown,
)
expect(response).to have_http_status(:ok)