Live Caller ID Lookup Example

Live Caller ID Lookup is a new feature that allows the system to communicate with a third party service to privately retrieve information about a phone number for an incoming call. This allows the system to automatically block known spam callers and display identity information on the incoming call screen.

This repository provides a functional server backend to test the Live Caller ID Lookup feature.

[!WARNING] While functional, this is just an example service and should not be run in production.

Overview

Live caller ID Lookup Example provides:

• PIRService, an example service for Live Caller ID Lookup.
• PrivacyPass, an implementation of the Privacy Pass publicly verifiable tokens.

The documentation lives at Swift Package Index.

Developing Live Caller ID Lookup Example

Building Live Caller ID Lookup Example requires:

• 64-bit processor with little-endian memory representation
• macOS or Linux operating system
• Swift version 6.0 or later

Additionally, developing Live Caller ID Lookup Example requires:

• Nick Lockwood SwiftFormat
• pre-commit
• SwiftLint

Building

You can build Live Caller ID Lookup Example either via Xcode or via command line in a terminal.

Xcode

To build Live Caller ID Lookup Example from Xcode, simply open the root directory (i.e., the live-caller-id-lookup-example directory) of the repository in Xcode. See the Xcode documentation for more details on developing with Xcode.

Command line

To build Live Caller ID Lookup Example from command line, open the root directory (i.e., the live-caller-id-lookup-example directory) of the repository in a terminal, and run

swift build -c release

The build products will be in the .build/release/ folder.

To build in debug mode, run

swift build

The build products will be in the .build/debug/ folder.

[!WARNING] Runtimes may be slow in debug mode.

Testing

Run unit tests via

swift test -c release --parallel

To run tests in debug mode, run

swift test --parallel

[!WARNING] Runtimes may be slow in debug mode.

Contributing

If you would like to make a pull request to Live Caller ID Lookup Example, please run pre-commit install. Then each commit will run some basic formatting checks.

Documentation

Live Caller ID Lookup Example uses DocC for documentation. For more information, refer to the DocC documentation and the Swift-DocC Plugin.

Xcode

The documentation can be built from Xcode via Product -> Build Documentation.

Command line

The documentation can be built from command line by running

swift package generate-documentation

and previewed by running

swift package --disable-sandbox preview-documentation --target PIRService