✨ Adding multipass function

[ponty33]

Changes

• Added Multipass class to generate multipass token or URL
• Updated doc
  

[hillairet]

@ponty33 Can this be completed? What's left?

[hillairet]

Copy your README.md to docs/index.md to fix the test.
These two files should be identical.

[hillairet]

@lishanl This could be useful. Do you mind looking at it to to see if it fits the rest of the code.
@ponty33 @lishanl Obviously up to you guys to decide who has time/interest in resolving conflicts and update things.

I think multipass needs its own section in the docs so it appears clearly in the menu on the left.

[ponty33]

I think I can work on it, good start for me to be involved in Spylib
But wow, it has been 10 months

[ponty33]

@lishanl Is there a way to preview the doc?

[lishanl]

@lishanl Is there a way to preview the doc?

start your mkdocs locally to check https://satelcreative.github.io/spylib/development-contributing/#build-and-run-documentation-lazydocsmkdocs @ponty33

[ponty33]

Updated doc:

[lishanl]

Thank you Frank for adding and completing this feature 😎

[hillairet]

@lishanl @ponty33 Let's talk about the design.

Is there a reason to have a class?

I would prefer a set of functions instead:

def generate_token(secret: str, contact_raw_data: Dict[str, Any]) -> bytes:
   ...

def generate_url(secret: str, contact_raw_data: Dict[str, Any], url: str) -> str:
    ...

The docs could show how to use partial to avoid passing around the secret.
The user can still have multipass.:

from spylib import multipass

url = multipass.generate_url(...

The small helper functions should start with _ (that applies to internal methods too):

def _get_keys(secret: str) -> Tuple[str, str]:
    key = SHA256.new(secret.encode('utf-8')).digest()
   return (key[0:16], key[16:32])

Bonus point if you use a dataclass or a pydantic model instead of a Tuple! 😉

[lishanl]

@lishanl @ponty33 Let's talk about the design.

Is there a reason to have a class?

I would prefer a set of functions instead:

def generate_token(secret: str, contact_raw_data: Dict[str, Any]) -> bytes:
   ...

def generate_url(secret: str, contact_raw_data: Dict[str, Any], url: str) -> str:
    ...

The docs could show how to use partial to avoid passing around the secret. The user can still have multipass.:

from spylib import multipass

url = multipass.generate_url(...

The small helper functions should start with _ (that applies to internal methods too):

def _get_keys(secret: str) -> Tuple[str, str]:
    key = SHA256.new(secret.encode('utf-8')).digest()
   return (key[0:16], key[16:32])

Bonus point if you use a dataclass or a pydantic model instead of a Tuple! 😉

OOP VS Functional programming 🥁

[hillairet]

@lishanl Well maybe ... is "multipass" really an object though?
I don't think having a bunch of class means doing OOP, if none of your classes actually represent objects.

[ponty33]

There wasn't much reason behind it. The code was referenced from an unmaintained repo, and it was written in class

I don't have much opinion on it, either way is fine to me

[hillairet]

@ponty33 Let's go with functions here please. No reason for a class.

[hillairet]

I believe the email is a required field and the only required field in the customer data dict. Please add a check so that SPyLib fails with a meaningful error message before the user makes the multipass API call.

[lishanl]

I am picking on the consistency here. 😅 Hope you don't mind Frank. It would be nice to have type annotations for all functions.

[hillairet]

Remove unused thing. Otherwise looks great.

[ponty33]

Finally closed after 329 days 😄

[lishanl]

Definitely top 1 on the leaderboard for the longest open PR that actually gets completed at the end. 🏆
Not to encourage this. But yea. Glad it's completed. 😆

[hillairet]

I miss PullPanda for that! The listing of records and averages was great!