MattT/APPEALS-30222

[ThorntonMatthew]

Resolves APPEALS-30222

Description

Creates a static Webex Meetings API service integration class for approximating the live API we will interact with in higher environments.

Acceptance Criteria

• An initializer is created for the Webex IC service in {{config/initializers}}
  • If ApplicationController.dependencies_faked? is true
    • Initialize WebexClient to Fakes::WebexService
  • If ApplicationController.dependencies_faked? is false
    • Initialize WebexClient to ExternalApi::WebexService
• A Fakes::WebexService class is created in lib/fakes
  • This class contains a create_conference instance method
  • This class contains a delete_conference instance method
    • Method signature:
      • delete_conference(conference_id: )

Testing Plan

1. Go to APEPALS-31219

• For feature branches merging into master: Was this deployed to UAT?

Best practices

Code Documentation Updates

• Add or update code comments at the top of the class, module, and/or component.

Tests

Test Coverage

Did you include any test coverage for your code? Check below:

• RSpec
• Jest
• Other

Code Climate

Your code does not add any new code climate offenses? If so why?

• No new code climate issues added

Monitoring, Logging, Auditing, Error, and Exception Handling Checklist

Monitoring

• Are performance metrics (e.g., response time, throughput) being tracked?
• Are key application components monitored (e.g., database, cache, queues)?
• Is there a system in place for setting up alerts based on performance thresholds?

Logging

• Are logs being produced at appropriate log levels (debug, info, warn, error, fatal)?
• Are logs structured (e.g., using log tags) for easier querying and analysis?
• Are sensitive data (e.g., passwords, tokens) redacted or omitted from logs?
• Is log retention and rotation configured correctly?
• Are logs being forwarded to a centralized logging system if needed?

Auditing

• Are user actions being logged for audit purposes?
• Are changes to critical data being tracked ?
• Are logs being securely stored and protected from tampering or exposing protected data?

Error Handling

• Are errors being caught and handled gracefully?
• Are appropriate error messages being displayed to users?
• Are critical errors being reported to an error tracking system (e.g., Sentry, ELK)?
• Are unhandled exceptions being caught at the application level ?

Exception Handling

• Are custom exceptions defined and used where appropriate?
• Is exception handling consistent throughout the codebase?
• Are exceptions logged with relevant context and stack trace information?
• Are exceptions being grouped and categorized for easier analysis and resolution?

[codeclimate]

Code Climate has analyzed commit 499a808 and detected 2 issues on this pull request.

Here's the issue category breakdown:

Category	Count
Complexity	2

View more on Code Climate.