Features/result

[mardiros]

/!\ API Break

This pull request change the response type on all method to wrap response in a "Result" object.

As a result, we have:

• the same API for the collection and non collection result.
• No exception raised to control the http error flow.
  • there are still a lot of exception raised for registration, contracts and so on that appears only while developping, integrating API

    api = await cli("gandi")
    if len(sys.argv) == 2:
        domain = sys.argv[1]
        domain_result = await api.domain.get(DomainParam(name=domain))
        domain = domain_result.unwrap()
        print(domain)
    else:
        domain_result = await api.domain.collection_get()
        domains = domain_result.unwrap()
        print(domains.meta)
        print()
        for domain in domains:
            print(domain)

• Update the code
• Update examples code
• Update the documentation

Fixes #30

[codecov-commenter]

Codecov Report

Merging #38 (2373e5d) into main (ebd35fb) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##              main       #38   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           46        46           
  Lines         1478      1533   +55     
=========================================
+ Hits          1478      1533   +55     

Impacted Files	Coverage Δ
src/blacksmith/domain/exceptions.py	100.00% <100.00%> (ø)
src/blacksmith/domain/model/params.py	100.00% <100.00%> (ø)
src/blacksmith/sd/_async/adapters/consul.py	100.00% <100.00%> (ø)
src/blacksmith/sd/_sync/adapters/consul.py	100.00% <100.00%> (ø)
src/blacksmith/service/_async/route_proxy.py	100.00% <100.00%> (ø)
src/blacksmith/service/_sync/route_proxy.py	100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[yanndinendal]

👍️

[olivier-m]

👍