Skip to content
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

Jump to bottom

Adding SIP routing functionality to PhoneNumbers SDK #22805

Merged
merged 77 commits into from
Jun 23, 2022
Merged

Adding SIP routing functionality to PhoneNumbers SDK #22805

merged 77 commits into from
Jun 23, 2022

Conversation

jiriburant
Copy link
Member

@jiriburant jiriburant commented Jan 27, 2022 •
edited
Loading

Description

Added the SipRoutingClient enabling management of SIP routing configuration for direct routing numbers.
Each Azure Communication resource has exactly one SIP configuration, containing a dictionary of trunks and a list of routes.
The trunks allow for partial updates, the configuration is merged with the incoming trunk dictionary. The routes don’t allow for partial updates, the whole list is replaced by the incoming list (if it is present on PATCH request).

The SIP routing client provides straigthforward methods to retrieve and manage SIP trunks and voice routes.

Note:
The API we are calling from the SDK is rather different from the SDK public interface, so we had to introduce two types for SIP trunks, called "SipTrunk" and "SipTrunkInternal", where "SipTrunk" is exposed to user and "SipTrunkInternal" is used for communication with backend API. This can be a bit confusing in the code, when the info is mapped to and from those types.

Resources:

API specification with API examples: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/communication/data-plane/SipRouting/preview/2021-05-01-preview
Conceptual doc, explaining the direct routing provisioning scenario: https://docs.microsoft.com/en-us/azure/communication-services/concepts/telephony/direct-routing-provisioning
Apiview link: https://apiview.dev/Assemblies/Review/b32afd45c457422992f506154f376d68

All SDK Contribution checklist:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

jiriburant and others added 30 commits May 25, 2021 09:40
@jiriburant
Initial commit
c54d87e
@jiriburant
Copied shared files
c6bb58b
@jiriburant
Added basic functionality to the sip client.
c6bdc1f
@jiriburant
Copied shared folder to get the utilities. Implemented sample files. …
33f5133 
…Changed naming in client
@jiriburant
Modified function comments and added class comment for _sip_routing_c…
8a5b5e3 
…lient.
@jiriburant
Fixed kwargs propagation
a929c00
@jiriburant
Changed sample file to pull parameteres from environment variables.
2d724f4
@jiriburant
Changed get SIP configuration sample to be a class to align with the …
4abde59 
…update samples. Changed naming of the update samples class.
@jiriburant
Implemented basic tests for the SIP client
9957f8e
@jiriburant
Removed unused import
91a5e1d
@jiriburant
Fixed comment.
74a552c
@jiriburant
Renamed variables dut_client to test_client.
c72a481
@jiriburant
Added samples and tests of functionality.
3a362d8
@jiriburant
Merge branch 'Azure:master' into feature/communication-sip-configuration
854cde6
@jiriburant
Merge from original repo
0a97142
@jiriburant
Feature/communication sip configuration dev/basic client functionality (
76df991 
#3)

Adding async client.
@jiriburant
Updated from original (#4)
95df4df 
Updated from main repo.
@jiriburant
Merge branch 'Azure:master' into master
a3b20fd
@jiriburant
Updated from upstream.
6c6654b
@jiriburant
Fixing pylint
5c6a037
@jiriburant
Changed value error to be compatible with python 2.
d1328d7
@jiriburant
Reverted changes for pylint.
00422ea
@jiriburant
Fixed dev requirements and MANIFEST
f5263ba
@jiriburant
Fixing async tests. Fixing comments.
f703cd9
@jiriburant
Removed async mock to be compatible with the builds.
3e09e24
@jiriburant
Fixing test failures for Ubuntu and Mac
cf9256f
@jiriburant
Changed versions for python. Fixed pylint issue in version.
ffda58d
@jiriburant
Modified _version file to prevent path errors.
ff9c526
@jiriburant
Added newline.
591bcdd
@jiriburant
Downgraded six version to match the frozen requirements.
03f5064
@azure-sdk
Copy link
Collaborator

API change check for azure-communication-phonenumbers

API changes have been detected in azure-communication-phonenumbers. You can review API changes here

@azure-sdk
Copy link
Collaborator

API change check

APIView has identified API level changes in this PR and created following API reviews.

azure-communication-phonenumbers

@jiriburant jiriburant marked this pull request as ready for review May 24, 2022 12:30
@jiriburant jiriburant requested a review from a team May 24, 2022 13:25
@jiriburant jiriburant marked this pull request as draft May 27, 2022 09:04
@jiriburant jiriburant marked this pull request as ready for review May 27, 2022 09:05
annatisch
annatisch reviewed Jun 3, 2022
View reviewed changes
sdk/communication/azure-communication-phonenumbers/README.md Outdated Show resolved Hide resolved
sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/__init__.py Outdated Show resolved Hide resolved
...ion/azure-communication-phonenumbers/azure/communication/phonenumbers/siprouting/__init__.py Outdated Show resolved Hide resolved
sdk/communication/azure-communication-phonenumbers/README.md Show resolved Hide resolved
...ommunication-phonenumbers/azure/communication/phonenumbers/siprouting/_sip_routing_client.py Outdated Show resolved Hide resolved
sdk/communication/azure-communication-phonenumbers/samples/siprouting/set_sip_trunks_sample .py Outdated Show resolved Hide resolved
sdk/communication/azure-communication-phonenumbers/samples/siprouting/set_sip_trunks_sample .py Outdated Show resolved Hide resolved
sdk/communication/azure-communication-phonenumbers/samples/siprouting/set_sip_trunk_sample.py Outdated Show resolved Hide resolved
...unication/azure-communication-phonenumbers/samples/siprouting/set_sip_trunks_sample_async.py Outdated Show resolved Hide resolved
sdk/communication/azure-communication-phonenumbers/samples/siprouting/set_sip_routes_sample.py Outdated Show resolved Hide resolved
@jiriburant jiriburant requested a review from annatisch June 7, 2022 15:45
@annatisch annatisch merged commit 7058612 into Azure:main Jun 23, 2022
iscai-msft added a commit to iscai-msft/azure-sdk-for-python that referenced this pull request Jun 27, 2022
@iscai-msft
Merge branch 'main' of https://github.com/Azure/azure-sdk-for-python …
d23dd87 
…into merge_patch

* 'main' of https://github.com/Azure/azure-sdk-for-python: (155 commits)
  {machine learning} || Fix a bug in the code (Azure#24922)
  [CLU] support for AAD + docs (Azure#24960)
  Update dpg version (Azure#24986)
  [Botservice]fix model (Azure#24971)
  [perf] Add pipeline template and storage pipelines (Azure#24894)
  [Storage] Remove client-side encryption code from shared (Azure#24931)
  [EventHubs&ServiceBus] update docker images to internal (Azure#24966)
  Sync eng/common directory with azure-sdk-tools for PR 3481 (Azure#24964)
  [Dpg] update to use global autorest version (Azure#24970)
  [CLU] release updates + fix tests (Azure#24963)
  [Test Proxy] Add method to reset setting customizations (Azure#24952)
  [Storage] Add proxy-supporting test classes (Azure#24937)
  [Confidential Ledger] Enable live testing (Azure#24912)
  fix type of _SansIOHTTPPolicyRunner (Azure#24932)
  Adding SIP routing functionality to PhoneNumbers SDK (Azure#22805)
  [DPG] update quick-start-tool (Azure#24942)
  [formrecognizer] Enable copy model tests (Azure#24917)
  [CLU] remove maxpagesize (Azure#24949)
  Use westus3 for translation live tests (Azure#24947)
  [Storage] Make lease duration tests less flakey (Azure#24930)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@annatisch annatisch annatisch approved these changes

Assignees
No one assigned
Labels
Communication
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jiriburant @azure-sdk @annatisch