Specification of address data object factory

reTHINK-project / core-framework

The main goal of WP3 is to provide the reTHINK core framework comprised by the runtime environment where Hyperties are executed and the messaging nodes used to support messages exchange between Hyperties.

Apache License 2.0

1 stars 0 forks source link

Specification of address data object factory #120

Closed acheambe closed 8 years ago

acheambe commented 8 years ago

The Address Resource Factory creates the different types of URLs required as specified here.

specification document template

antonroman commented 8 years ago

After analyzing the requirements for the URL factory we propose to follow the approach below:

for the implementation ES6 standard getters and setters will be used.
this is the temptative list of methods: getter and setter for each of this values: scheme, username, password, host, port, path, query, fragment.
For some of the values above (at least: path, query and fragment) the set method will check if the inserted value is syntactically valid if already specified if not an exception will be raised.
Errors will be handled with exceptions.
A method will be included to check the consistence of the URL scheme after modifying values and another one to check the consistency status (OK, NOK).

We'll create an initial version of the class so that can be used now and then we'll be adding the intelligence to verify the semantics.

pchainho commented 8 years ago

I would suggest to have it as much as possible compliant with WHATWG URL API standard, which was the basis of the reTHINK address model design and I've found this implementation:

https://github.com/jsdom/whatwg-url

aecostas commented 8 years ago

@pchainho sure! We will review that implementation and study if we can reuse it for the reThink purposes. Moreover, some additional logic will be necessary to add some intelligence to decide if a given set of values for each field are consistent between them and coherent with the project description.

BTW, could you, please, give me access to https://github.com/reTHINK-project/architecture/blob/master/docs/datamodel/address/readme.md?? @antonroman shared a copy with me, but I don't have permission to read it in github.

Thanks,

pchainho commented 8 years ago

I've just added you, @aecostas, to WP2 team : can you check pls?

aecostas commented 8 years ago

Thanks @pchainho, it works

acheambe commented 8 years ago

@aecostas : Great. Could you please use this document to specify the class attributes, constructor(s) and functionalities. Thx

antonroman commented 8 years ago

At the end of the day we'll have completed 20% of the task, @acheambe please add @aecostas to frameworker-developer team so that we can start pushing code. Thanks!

acheambe commented 8 years ago

Done. @aecostas should now have access to repository. In case you run into any problems on repo please let me know.

acheambe commented 8 years ago

specification completed. Follow-up to this task in dev-service-framework repository