ぼざクリタグ広場 https://hub.nizika.monster
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

409 lines
13 KiB

  1. require 'cgi'
  2. require 'rails_helper'
  3. require 'securerandom'
  4. RSpec.describe 'Wiki API', type: :request do
  5. let!(:user) { create_member_user! }
  6. let!(:tn) { TagName.create!(name: 'spec_wiki_title') }
  7. let!(:page) do
  8. WikiPage.create!(tag_name: tn, created_user: user, updated_user: user).tap do |p|
  9. Wiki::Commit.content!(page: p, body: 'init', created_user: user, message: 'init')
  10. end
  11. end
  12. describe 'GET /wiki' do
  13. it 'returns wiki pages with title' do
  14. get '/wiki'
  15. expect(response).to have_http_status(:ok)
  16. expect(json).to be_an(Array)
  17. expect(json).not_to be_empty
  18. expect(json[0]).to have_key('title')
  19. expect(json.map { |p| p['title'] }).to include('spec_wiki_title')
  20. end
  21. end
  22. describe 'GET /wiki/:id' do
  23. subject(:request) do
  24. get "/wiki/#{ page_id }"
  25. end
  26. let(:page_id) { page.id }
  27. context 'when wiki page exists' do
  28. it 'returns wiki page with title' do
  29. request
  30. expect(response).to have_http_status(:ok)
  31. expect(json).to include(
  32. 'id' => page.id,
  33. 'title' => 'spec_wiki_title')
  34. end
  35. end
  36. context 'when wiki page does not exist' do
  37. let(:page_id) { 9_999_999 }
  38. it 'returns 404' do
  39. request
  40. expect(response).to have_http_status(:not_found)
  41. end
  42. end
  43. end
  44. describe 'POST /wiki' do
  45. let(:endpoint) { '/wiki' }
  46. let(:member) { create(:user, role: 'member') }
  47. let(:guest) { create(:user, role: 'guest') }
  48. def auth_headers(user)
  49. { 'X-Transfer-Code' => user.inheritance_code }
  50. end
  51. context 'when not logged in' do
  52. it 'returns 401' do
  53. post endpoint, params: { title: 'Test', body: 'Hello' }
  54. expect(response).to have_http_status(:unauthorized)
  55. end
  56. end
  57. context 'when logged in but not member' do
  58. it 'returns 403' do
  59. post endpoint, params: { title: 'Test', body: 'Hello' }, headers: auth_headers(guest)
  60. expect(response).to have_http_status(:forbidden)
  61. end
  62. end
  63. context 'when params invalid' do
  64. it 'returns 422 when title blank' do
  65. post endpoint, params: { title: '', body: 'Hello' }, headers: auth_headers(member)
  66. expect(response).to have_http_status(:unprocessable_entity)
  67. end
  68. it 'returns 422 when body blank' do
  69. post endpoint, params: { title: 'Test', body: '' }, headers: auth_headers(member)
  70. expect(response).to have_http_status(:unprocessable_entity)
  71. end
  72. end
  73. context 'when success' do
  74. it 'creates wiki_page and first content revision' do
  75. expect do
  76. post endpoint, params: { title: 'TestPage', body: "a\nb\nc", message: 'init' },
  77. headers: auth_headers(member)
  78. end
  79. .to change(WikiPage, :count).by(1)
  80. .and change(WikiRevision, :count).by(1)
  81. expect(response).to have_http_status(:created)
  82. page_id = json.fetch('id')
  83. expect(json.fetch('title')).to eq('TestPage')
  84. expect(json.fetch('body')).to eq("a\nb\nc")
  85. page = WikiPage.find(page_id)
  86. rev = page.current_revision
  87. expect(rev).to be_present
  88. expect(rev).to be_content
  89. expect(rev.message).to eq('init')
  90. expect(page.body).to eq("a\nb\nc")
  91. expect(rev.lines_count).to eq(3)
  92. expect(rev.wiki_revision_lines.order(:position).pluck(:position)).to eq([0, 1, 2])
  93. expect(rev.wiki_lines.pluck(:body)).to match_array(%w[a b c])
  94. end
  95. end
  96. end
  97. describe 'PUT /wiki/:id' do
  98. let(:member) { create(:user, role: 'member', inheritance_code: SecureRandom.hex(16)) }
  99. let(:guest) { create(:user, role: 'guest', inheritance_code: SecureRandom.hex(16)) }
  100. def auth_headers(user)
  101. { 'X-Transfer-Code' => user.inheritance_code }
  102. end
  103. #let!(:page) { create(:wiki_page, title: 'TestPage') }
  104. let!(:page) do
  105. build(:wiki_page, title: 'TestPage').tap do |p|
  106. puts p.errors.full_messages unless p.valid?
  107. p.save!
  108. end
  109. end
  110. before do
  111. # 初期版を 1 つ作っておく(更新が“2版目”になるように)
  112. Wiki::Commit.content!(page: page, body: "a\nb", created_user: member, message: 'init')
  113. end
  114. context 'when not logged in' do
  115. it 'returns 401' do
  116. put "/wiki/#{page.id}", params: { title: 'TestPage', body: 'x' }
  117. expect(response).to have_http_status(:unauthorized)
  118. end
  119. end
  120. context 'when logged in but not member' do
  121. it 'returns 403' do
  122. put "/wiki/#{page.id}",
  123. params: { title: 'TestPage', body: 'x' },
  124. headers: auth_headers(guest)
  125. expect(response).to have_http_status(:forbidden)
  126. end
  127. end
  128. context 'when params invalid' do
  129. it 'returns 422 when body blank' do
  130. put "/wiki/#{page.id}",
  131. params: { title: 'TestPage', body: '' },
  132. headers: auth_headers(member)
  133. expect(response).to have_http_status(:unprocessable_entity)
  134. end
  135. it 'returns 422 when title mismatched (if you forbid rename here)' do
  136. put "/wiki/#{page.id}",
  137. params: { title: 'OtherTitle', body: 'x' },
  138. headers: auth_headers(member)
  139. # 君の controller 例だと title 変更は 422 にしてた
  140. expect(response).to have_http_status(:unprocessable_entity)
  141. end
  142. end
  143. context 'when success' do
  144. it 'creates new revision and returns 200' do
  145. current_id = page.wiki_revisions.maximum(:id)
  146. expect do
  147. put "/wiki/#{page.id}",
  148. params: { title: 'TestPage', body: "x\ny", message: 'edit', base_revision_id: current_id },
  149. headers: auth_headers(member)
  150. end.to change(WikiRevision, :count).by(1)
  151. expect(response).to have_http_status(:ok)
  152. page.reload
  153. rev = page.current_revision
  154. expect(rev).to be_content
  155. expect(rev.message).to eq('edit')
  156. expect(page.body).to eq("x\ny")
  157. expect(rev.base_revision_id).to eq(current_id)
  158. end
  159. end
  160. # TODO: コンフリクト未実装のため,実装したらコメント外す.
  161. # context 'when conflict' do
  162. # it 'returns 409 when base_revision_id mismatches' do
  163. # # 先に別ユーザ(同じ member でもOK)が 1 回更新して先頭を進める
  164. # Wiki::Commit.content!(page: page, body: "zzz", created_user: member, message: 'other edit')
  165. # page.reload
  166. # stale_id = page.wiki_revisions.order(:id).first.id # わざと古い id
  167. # put "/wiki/#{page.id}",
  168. # params: { title: 'TestPage', body: 'x', base_revision_id: stale_id },
  169. # headers: auth_headers(member)
  170. # expect(response).to have_http_status(:conflict)
  171. # json = JSON.parse(response.body)
  172. # expect(json['error']).to eq('conflict')
  173. # end
  174. # end
  175. context 'when page not found' do
  176. it 'returns 404' do
  177. put "/wiki/99999999",
  178. params: { title: 'X', body: 'x' },
  179. headers: auth_headers(member)
  180. expect(response).to have_http_status(:not_found)
  181. end
  182. end
  183. end
  184. describe 'GET /wiki/title/:title' do
  185. it 'returns wiki page by title' do
  186. get "/wiki/title/#{CGI.escape('spec_wiki_title')}"
  187. expect(response).to have_http_status(:ok)
  188. expect(json).to have_key('id')
  189. expect(json).to have_key('title')
  190. expect(json['id']).to eq(page.id)
  191. expect(json['title']).to eq('spec_wiki_title')
  192. end
  193. it 'returns 404 when not found' do
  194. get "/wiki/title/#{ CGI.escape('nope') }"
  195. expect(response).to have_http_status(:not_found)
  196. end
  197. end
  198. describe 'GET /wiki/search' do
  199. before do
  200. # 追加で検索ヒット用
  201. TagName.create!(name: 'spec_wiki_title_2')
  202. WikiPage.create!(tag_name: TagName.find_by!(name: 'spec_wiki_title_2'),
  203. created_user: user, updated_user: user)
  204. TagName.create!(name: 'unrelated_title')
  205. WikiPage.create!(tag_name: TagName.find_by!(name: 'unrelated_title'),
  206. created_user: user, updated_user: user)
  207. end
  208. it 'returns up to 20 pages filtered by title like' do
  209. get "/wiki/search?title=#{CGI.escape('spec_wiki')}"
  210. expect(response).to have_http_status(:ok)
  211. expect(json).to be_an(Array)
  212. titles = json.map { |p| p['title'] }
  213. expect(titles).to include('spec_wiki_title', 'spec_wiki_title_2')
  214. expect(titles).not_to include('unrelated_title')
  215. end
  216. it 'returns all when title param is blank' do
  217. get "/wiki/search?title=#{CGI.escape('')}"
  218. expect(response).to have_http_status(:ok)
  219. expect(json).to be_an(Array)
  220. expect(json.map { |p| p['title'] }).to include('spec_wiki_title')
  221. end
  222. end
  223. describe 'GET /wiki/changes' do
  224. let!(:rev1) do
  225. Wiki::Commit.content!(page: page, body: "a\nb", created_user: user, message: 'r1')
  226. page.current_revision
  227. end
  228. let!(:rev2) do
  229. Wiki::Commit.content!(page: page, body: "a\nc", created_user: user, message: 'r2')
  230. page.current_revision
  231. end
  232. it 'returns latest revisions (optionally filtered by page id)' do
  233. get "/wiki/changes?id=#{page.id}"
  234. expect(response).to have_http_status(:ok)
  235. expect(json).to be_an(Array)
  236. expect(json).not_to be_empty
  237. top = json.first
  238. expect(top).to include(
  239. 'revision_id' => rev2.id,
  240. 'pred' => rev2.base_revision_id,
  241. 'succ' => nil,
  242. 'kind' => 'content',
  243. 'message' => 'r2'
  244. )
  245. expect(top['wiki_page']).to include('id' => page.id, 'title' => 'spec_wiki_title')
  246. expect(top['user']).to include('id' => user.id, 'name' => user.name)
  247. expect(top).to have_key('timestamp')
  248. # order desc をざっくり担保
  249. ids = json.map { |x| x['revision_id'] }
  250. expect(ids).to eq(ids.sort.reverse)
  251. end
  252. it 'returns empty array when page has no revisions and filtered by id' do
  253. # 別ページを作って revision 無し
  254. tn2 = TagName.create!(name: 'spec_no_rev')
  255. p2 = WikiPage.create!(tag_name: tn2, created_user: user, updated_user: user)
  256. get "/wiki/changes?id=#{p2.id}"
  257. expect(response).to have_http_status(:ok)
  258. expect(json).to eq([])
  259. end
  260. end
  261. describe 'GET /wiki/title/:title/exists' do
  262. it 'returns 204 when exists' do
  263. get "/wiki/title/#{CGI.escape('spec_wiki_title')}/exists"
  264. expect(response).to have_http_status(:no_content)
  265. expect(response.body).to be_empty
  266. end
  267. it 'returns 404 when not exists' do
  268. get "/wiki/title/#{CGI.escape('nope')}/exists"
  269. expect(response).to have_http_status(:not_found)
  270. end
  271. end
  272. describe 'GET /wiki/:id/exists' do
  273. it 'returns 204 when exists' do
  274. get "/wiki/#{page.id}/exists"
  275. expect(response).to have_http_status(:no_content)
  276. expect(response.body).to be_empty
  277. end
  278. it 'returns 404 when not exists' do
  279. get "/wiki/99999999/exists"
  280. expect(response).to have_http_status(:not_found)
  281. end
  282. end
  283. describe 'GET /wiki/:id/diff' do
  284. let!(:rev_a) do
  285. Wiki::Commit.content!(page: page, body: "a\nb\nc", created_user: user, message: 'A')
  286. page.current_revision
  287. end
  288. let!(:rev_b) do
  289. Wiki::Commit.content!(page: page, body: "a\nx\nc", created_user: user, message: 'B')
  290. page.current_revision
  291. end
  292. it 'returns diff json between revisions' do
  293. get "/wiki/#{page.id}/diff?from=#{rev_a.id}&to=#{rev_b.id}"
  294. expect(response).to have_http_status(:ok)
  295. expect(json).to include(
  296. 'wiki_page_id' => page.id,
  297. 'title' => 'spec_wiki_title',
  298. 'older_revision_id' => rev_a.id,
  299. 'newer_revision_id' => rev_b.id
  300. )
  301. expect(json['diff']).to be_an(Array)
  302. # ざっくり「b が消えて x が増えた」が含まれることを確認
  303. types = json['diff'].map { |x| x['type'] }
  304. expect(types).to include('removed', 'added').or include('removed').and include('added')
  305. end
  306. it 'uses latest as "to" when to is omitted' do
  307. get "/wiki/#{page.id}/diff?from=#{rev_a.id}"
  308. expect(response).to have_http_status(:ok)
  309. expect(json['older_revision_id']).to eq(rev_a.id)
  310. expect(json['newer_revision_id']).to eq(page.current_revision.id)
  311. end
  312. it 'returns 422 when "to" is redirect revision' do
  313. # redirect revision を作る
  314. tn2 = TagName.create!(name: 'redirect_target')
  315. target = WikiPage.create!(tag_name: tn2, created_user: user, updated_user: user)
  316. Wiki::Commit.redirect!(page: page, redirect_page: target, created_user: user, message: 'redir')
  317. redirect_rev = page.current_revision
  318. expect(redirect_rev).to be_redirect
  319. get "/wiki/#{page.id}/diff?from=#{rev_a.id}&to=#{redirect_rev.id}"
  320. expect(response).to have_http_status(:unprocessable_entity)
  321. end
  322. it 'returns 422 when "from" is redirect revision' do
  323. tn2 = TagName.create!(name: 'redirect_target2')
  324. target = WikiPage.create!(tag_name: tn2, created_user: user, updated_user: user)
  325. Wiki::Commit.redirect!(page: page, redirect_page: target, created_user: user, message: 'redir2')
  326. redirect_rev = page.current_revision
  327. get "/wiki/#{page.id}/diff?from=#{redirect_rev.id}&to=#{rev_b.id}"
  328. expect(response).to have_http_status(:unprocessable_entity)
  329. end
  330. end
  331. end