Skip to content

Enforce YARD parameter documentation for tracker_events.rb, fix errors #6964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zachmargolis merged 1 commit into from
Sep 15, 2022
Merged

Enforce YARD parameter documentation for tracker_events.rb, fix errors #6964

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ lint: ## Runs all lint tests
bundle exec rubocop --parallel
@echo "--- analytics_events ---"
make lint_analytics_events
make lint_tracker_events
@echo "--- brakeman ---"
bundle exec brakeman
@echo "--- bundler-audit ---"
Expand Down
20 changes: 11 additions & 9 deletions app/services/irs_attempts_api/tracker_events.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# rubocop:disable Metrics/ModuleLength
module IrsAttemptsApi
module TrackerEvents
# param [Boolean] success True if Account Successfully Deleted
# @param [Boolean] success True if Account Successfully Deleted
# A User deletes their Login.gov account
def account_purged(success:)
track_event(
Expand All @@ -12,8 +12,8 @@ def account_purged(success:)
)
end

# param [Boolean] success True if Account Successfully Deleted
# param [Hash<Key, Array<String>>] failure_reason displays why account deletion failed
# @param [Boolean] success True if Account Successfully Deleted
# @param [Hash<Key, Array<String>>] failure_reason displays why account deletion failed
# A User confirms and deletes their Login.gov account after 24 hour period
def account_reset_account_deleted(success:, failure_reason:)
track_event(
Expand All @@ -23,7 +23,7 @@ def account_reset_account_deleted(success:, failure_reason:)
)
end

# param [Boolean] success True if account reset request is cancelled
# @param [Boolean] success True if account reset request is cancelled
# A user cancels the request to delete their account before 24 hour period
def account_reset_cancel_request(success:)
track_event(
Expand Down Expand Up @@ -146,8 +146,8 @@ def idv_document_upload_submitted(
)
end

# param [Boolean] Success
# param [Hash<Key, Array<String>>] failure_reason displays GPO submission failed
# @param [Boolean] success
# @param [Hash<Key, Array<String>>] failure_reason displays GPO submission failed
# GPO verification submitted from Letter sent to verify address
def idv_gpo_verification_submitted(success:, failure_reason:)
track_event(
Expand Down Expand Up @@ -225,7 +225,7 @@ def idv_phone_otp_sent_rate_limited

# Tracks when a user submits OTP code sent to their phone
# @param [String] phone_number
# param [Boolean] success
# @param [Boolean] success
# @param [Hash<Symbol,Array<Symbol>>] failure_reason
def idv_phone_otp_submitted(phone_number:, success:, failure_reason: nil)
track_event(
Expand Down Expand Up @@ -256,7 +256,7 @@ def idv_phone_send_link_rate_limited(phone_number:)

# Tracks when the user submits their idv phone number
# @param [String] phone_number
# param [Boolean] success
# @param [Boolean] success
# @param [Hash<Symbol,Array<Symbol>>] failure_reason
def idv_phone_submitted(phone_number:, success:, failure_reason: nil)
track_event(
Expand Down Expand Up @@ -327,6 +327,7 @@ def idv_verification_rate_limited
# @param [String] last_name
# @param [String] date_of_birth
# @param [String] address
# @param [String] ssn
# @param [Hash<Symbol,Array<Symbol>>] failure_reason
# The verification was submitted during the IDV process
def idv_verification_submitted(
Expand Down Expand Up @@ -541,7 +542,8 @@ def mfa_login_phone_otp_sent_rate_limited(phone_number:)
)
end

# @param [Boolean] success - True if the sms otp submitted matched what was sent
# @param [Boolean] reauthentication if the user was already logged in
# @param [Boolean] success True if the sms otp submitted matched what was sent
# During a login attempt, the user, having previously been sent an OTP code via SMS
# has entered an OTP code.
def mfa_login_phone_otp_submitted(reauthentication:, success:)
Expand Down