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

Refactor: Remove Dsp naming convention from EdcAdapterService and EDCRrequestBodyBuilder #101

Closed
tom-rm-meyer-ISST opened this issue Dec 3, 2023 · 1 comment · Fixed by #102
Closed

Refactor: Remove Dsp naming convention from EdcAdapterService and EDCRrequestBodyBuilder #101

tom-rm-meyer-ISST opened this issue Dec 3, 2023 · 1 comment · Fixed by #102

Comments

@tom-rm-meyer-ISST
Copy link
Contributor

During PR #93, I noticed that we could increase readability in the classes

This PR should mainly fix three things:

  • check for naming convention using abbreviations (e.g. EDCRequestBodyBuilder should be EdcRequestBodyBuilder)
  • PullTransfers / DataPullTransfers should be ProxyPullTransfers
  • remove dsp in method names as we only provide DSP not IDS
  • EdcAdapterService still use terms with simplePolicy -> should be publicPolicy same as EDCREquestBodyBuilder

My proposals / notes:

  • EdcAdapterService:
    • registerDSPSimpleContractDefintion -> rename registerContractDefintionWithPublicPolicy (more expressive)
    • registerDSPSimplePolicy -> rename registerPublicPolicy
    • registerDSPApiAsset -> registerProductStockApiAsset (more expressive)
    • getDSPCatalogItems -> rename getCatalogItems
    • startDspNegotiation -> startNegotiation / initiateNegotiation
    • getDspNegotatiationState -> getNegotiationState
    • sendDspGetRequest, sendDspPostRequest
    • startDspPullTransfer -> startProxyPullTransfer / intiateProxyPullTransfer
    • getDspTransferState -> getTransferState
    • sendDataPullRequest -> postProxyPullRequest
  • EDCRequestBodyBuilder -> rename EdcRequestBodyBuilder
    • here I would remove the Dsp in method names, too
    • buildDSPDataPullRequestBody -> buildProxyPullRequestBody
@tom-rm-meyer-ISST tom-rm-meyer-ISST mentioned this issue Dec 3, 2023
Merged
2 tasks
@eschrewe eschrewe mentioned this issue Dec 4, 2023
Merged
2 tasks
@tom-rm-meyer-ISST
Copy link
Contributor Author

solved with #102

@tom-rm-meyer-ISST tom-rm-meyer-ISST linked a pull request Dec 6, 2023 that will close this issue
refactor: update naming conventions in EDC classes #102
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

refactor: update naming conventions in EDC classes FraunhoferISST/puris
1 participant
@tom-rm-meyer-ISST