Add fields to API responses of active and expired pushes (#3512)

* Add tests for old API expired and active push responses

* Update fields in API responses for expired and active pushes

* Update indentations of some tests

* Update tests of file pushes

* Update a test of file pushes for API requests

* Remove unnecessary parts of tests of API responses

* Remove `files` from API responses of `active` and `expired` pushes

Author: ozovalihasan

app/views/pushes/_push.json.jbuilder

@@ -15,7 +15,7 @@ json.extract! push, :expire_after_views,
 json.json_url secret_url(push) + ".json"
 json.html_url secret_url(push)
 
-if controller.action_name == "create"
+if %w[create active expired].include?(controller.action_name)
   json.note push.note
   json.name push.name
 end

test/integration/file_push/file_push_json_active_test.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class FilePushJsonActiveTest < ActionDispatch::IntegrationTest
+  include Devise::Test::IntegrationHelpers
+
+  setup do
+    Settings.enable_logins = true
+    Settings.enable_file_pushes = true
+    Rails.application.reload_routes!
+
+    @luca = users(:luca)
+    @luca.confirm
+  end
+
+  def test_basic_json_expired
+    post file_pushes_path(format: :json),
+      params: {
+        file_push: {
+          payload: "Message",
+          name: "Test File Push",
+          note: "This is a test file push",
+          files: [
+            fixture_file_upload("monkey.png", "image/jpeg")
+          ]
+        }
+      },
+      headers: {"X-User-Email": @luca.email, "X-User-Token": @luca.authentication_token}
+    assert_response :success
+
+    get active_file_pushes_path(format: :json), headers: {"X-User-Email": @luca.email, "X-User-Token": @luca.authentication_token}
+    assert_response :success
+
+    res = JSON.parse(@response.body)
+    push = res.first
+    assert_not push.key?("payload")
+    assert push.key?("url_token")
+    assert push.key?("name")
+    assert_equal "Test File Push", push["name"]
+    assert push.key?("note")
+    assert_equal "This is a test file push", push["note"]
+    assert push.key?("expired")
+    assert_equal false, push["expired"]
+    assert push.key?("expired_on")
+    assert push.key?("deleted")
+    assert_equal false, push["deleted"]
+    assert push.key?("deletable_by_viewer")
+    assert_equal true, push["deletable_by_viewer"]
+    assert_equal push.keys.sort, ["created_at", "days_remaining", "deletable_by_viewer", "deleted", "expire_after_days", "expire_after_views", "expired", "expired_on", "html_url", "json_url", "name", "note", "passphrase", "retrieval_step", "updated_at", "url_token", "views_remaining"].sort
+    assert_equal push.except("url_token", "created_at", "updated_at", "html_url", "json_url", "expired_on"), {
+      "expire_after_views" => 5,
+      "expired" => false,
+      "deletable_by_viewer" => true,
+      "retrieval_step" => false,
+      "passphrase" => "",
+      "expire_after_days" => 7,
+      "days_remaining" => 7,
+      "views_remaining" => 5,
+      "deleted" => false,
+      "note" => "This is a test file push",
+      "name" => "Test File Push"
+    }
+  end
+end

test/integration/file_push/file_push_json_expired_test.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class FilePushJsonExpiredTest < ActionDispatch::IntegrationTest
+  include Devise::Test::IntegrationHelpers
+
+  setup do
+    Settings.enable_logins = true
+    Settings.enable_file_pushes = true
+    Rails.application.reload_routes!
+
+    @luca = users(:luca)
+    @luca.confirm
+  end
+
+  def test_basic_json_expired
+    post file_pushes_path(format: :json),
+      params: {
+        file_push: {
+          payload: "Message",
+          name: "Test File Push",
+          note: "This is a test file push",
+          files: [
+            fixture_file_upload("monkey.png", "image/jpeg")
+          ]
+        }
+      },
+      headers: {"X-User-Email": @luca.email, "X-User-Token": @luca.authentication_token}
+    assert_response :success
+
+    res = JSON.parse(@response.body)
+    delete "/f/#{res["url_token"]}.json"
+    assert_response :success
+
+    get expired_file_pushes_path(format: :json), headers: {"X-User-Email": @luca.email, "X-User-Token": @luca.authentication_token}
+    assert_response :success
+
+    res = JSON.parse(@response.body)
+    push = res.first
+    assert_not push.key?("payload")
+    assert push.key?("url_token")
+    assert push.key?("name")
+    assert_equal "Test File Push", push["name"]
+    assert push.key?("note")
+    assert_equal "This is a test file push", push["note"]
+    assert push.key?("expired")
+    assert_equal true, push["expired"]
+    assert push.key?("expired_on")
+    assert push.key?("deleted")
+    assert_equal true, push["deleted"]
+    assert push.key?("deletable_by_viewer")
+    assert_equal true, push["deletable_by_viewer"]
+    assert_equal push.keys.sort, ["created_at", "days_remaining", "deletable_by_viewer", "deleted", "expire_after_days", "expire_after_views", "expired", "expired_on", "html_url", "json_url", "name", "note", "passphrase", "retrieval_step", "updated_at", "url_token", "views_remaining"].sort
+    assert_equal push.except("url_token", "created_at", "updated_at", "html_url", "json_url", "expired_on"), {
+      "expire_after_views" => 5,
+      "expired" => true,
+      "deletable_by_viewer" => true,
+      "retrieval_step" => false,
+      "passphrase" => nil,
+      "expire_after_days" => 7,
+      "days_remaining" => 7,
+      "views_remaining" => 5,
+      "deleted" => true,
+      "note" => "This is a test file push",
+      "name" => "Test File Push"
+    }
+  end
+end

test/integration/password/password_json_active_test.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class PasswordJsonExpiredTest < ActionDispatch::IntegrationTest
+  include Devise::Test::IntegrationHelpers
+
+  setup do
+    Settings.enable_logins = true
+    Rails.application.reload_routes!
+
+    @luca = users(:luca)
+    @luca.confirm
+  end
+
+  def test_basic_json_expired
+    post passwords_path(format: :json),
+      params: {password: {payload: "testpw", name: "Test Password", note: "This is a test password"}},
+      headers: {"X-User-Email": @luca.email, "X-User-Token": @luca.authentication_token}
+    assert_response :success
+
+    get active_passwords_path(format: :json), headers: {"X-User-Email": @luca.email, "X-User-Token": @luca.authentication_token}
+    assert_response :success
+
+    res = JSON.parse(@response.body)
+    first_res = res.first
+    assert_not first_res.key?("payload")
+    assert first_res.key?("url_token")
+    assert first_res.key?("name")
+    assert_equal "Test Password", first_res["name"]
+    assert first_res.key?("note")
+    assert_equal "This is a test password", first_res["note"]
+    assert first_res.key?("expired")
+    assert_equal false, first_res["expired"]
+    assert first_res.key?("expired_on")
+    assert first_res.key?("deleted")
+    assert_equal false, first_res["deleted"]
+    assert first_res.key?("deletable_by_viewer")
+    assert_equal first_res.keys.sort, ["created_at", "days_remaining", "deletable_by_viewer", "deleted", "expire_after_days", "expire_after_views", "expired", "expired_on", "html_url", "json_url", "name", "note", "passphrase", "retrieval_step", "updated_at", "url_token", "views_remaining"].sort
+    assert_equal first_res.except("url_token", "created_at", "updated_at", "html_url", "json_url", "expired_on"), {
+      "expire_after_views" => 5,
+      "expired" => false,
+      "deletable_by_viewer" => true,
+      "retrieval_step" => false,
+      "passphrase" => "",
+      "expire_after_days" => 7,
+      "days_remaining" => 7,
+      "views_remaining" => 5,
+      "deleted" => false,
+      "note" => "This is a test password",
+      "name" => "Test Password"
+    }
+  end
+end

test/integration/password/password_json_expired_test.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class PasswordJsonExpiredTest < ActionDispatch::IntegrationTest
+  include Devise::Test::IntegrationHelpers
+
+  setup do
+    Settings.enable_logins = true
+    Rails.application.reload_routes!
+
+    @luca = users(:luca)
+    @luca.confirm
+  end
+
+  def test_basic_json_expired
+    post passwords_path(format: :json),
+      params: {password: {payload: "testpw", name: "Test Password", note: "This is a test password"}},
+      headers: {"X-User-Email": @luca.email, "X-User-Token": @luca.authentication_token}
+    assert_response :success
+
+    res = JSON.parse(@response.body)
+    # Delete the new password via json e.g. /p/<url_token>.json
+    delete "/p/#{res["url_token"]}.json"
+    assert_response :success
+
+    get expired_passwords_path(format: :json), headers: {"X-User-Email": @luca.email, "X-User-Token": @luca.authentication_token}
+    assert_response :success
+
+    res = JSON.parse(@response.body)
+    first_res = res.first
+    assert_not first_res.key?("payload")
+    assert first_res.key?("url_token")
+    assert first_res.key?("name")
+    assert_equal "Test Password", first_res["name"]
+    assert first_res.key?("note")
+    assert_equal "This is a test password", first_res["note"]
+    assert first_res.key?("expired")
+    assert_equal true, first_res["expired"]
+    assert first_res.key?("expired_on")
+    assert first_res.key?("deleted")
+    assert_equal true, first_res["deleted"]
+    assert first_res.key?("deletable_by_viewer")
+    assert_equal first_res.keys.sort, ["created_at", "days_remaining", "deletable_by_viewer", "deleted", "expire_after_days", "expire_after_views", "expired", "expired_on", "html_url", "json_url", "name", "note", "passphrase", "retrieval_step", "updated_at", "url_token", "views_remaining"].sort
+    assert_equal first_res.except("url_token", "created_at", "updated_at", "html_url", "json_url", "expired_on"), {
+      "expire_after_views" => 5,
+      "expired" => true,
+      "deletable_by_viewer" => true,
+      "retrieval_step" => false,
+      "passphrase" => nil,
+      "expire_after_days" => 7,
+      "days_remaining" => 7,
+      "views_remaining" => 5,
+      "deleted" => true,
+      "note" => "This is a test password",
+      "name" => "Test Password"
+    }
+  end
+end