Add support for Sift Verification Product by dereksweet · Pull Request #2 · apartmenttherapy/siftsciex

dereksweet · 2020-11-06T18:43:25Z

What does this PR do & why?

This PR adds support for the Sift verification product, their 2FA offering that will deliver one time passwords to customers for security reasons. Is intended to be used for login but can be applied to any event they support.

How can this be manually tested?

You will need to become quite familiar with the Sift Verification product to manually test it, as well as have Sift turn the feature on for you. The integration guide can be found here: https://docs.google.com/document/d/11RK_oss2Z7TjydnugYHlG5tK41GMpCyfbNbjzZAYSfM/edit

Any questions or concerns about this change?

We have been using this branch at therealreal.com for a few months now so we are quite certain it's performing as expected. There are no changes to any of the existing functionality, just added a bunch of new methods to use for the Verification product.

Deployment Notes

No deployment notes

add a reviewer
run appropriate tests
tag anyone who might want to see this
update any relevant wiki documentation

Add support for the following fields for an update_account event - $session_id - update_status

Add support for the Verification API, following 3 endpoints: - /send - /resend - /check

- Basic automated testing added for the Verification product via doctest - Fixed compiler warnings when running full test suite

dereksweet · 2020-11-06T18:44:32Z

-      %Account{"$user_email": "bob@example.com", "$user_id": "bob", "$api_key": api_key, "$type": "$create_account"}
+      %Account{"$user_email": "bob@example.com", "$user_id": "bob", "$api_key": api_key(), "$type": "$create_account"}

      iex> Account.create_account(%{user_email: "bob@example.com", user_id: "bob", payment_methods: [%{payment_type: :cash}]})
-      %Account{"$user_email": "bob@example.com", "$user_id": "bob", "$api_key": api_key, "$payment_methods": [%PaymentMethod{"$payment_type": "$cash"}], "$type": "$create_account"}
+      %Account{"$user_email": "bob@example.com", "$user_id": "bob", "$api_key": api_key(), "$payment_methods": [%PaymentMethod{"$payment_type": "$cash"}], "$type": "$create_account"}

      iex> Account.create_account(%{user_email: "bob@example.com", user_id: "bob", billing_address: %{name: "Bob", zipcode: "87102"}})
-      %Account{"$user_email": "bob@example.com", "$user_id": "bob", "$type": "$create_account", "$api_key": api_key, "$billing_address": %Address{"$name": "Bob", "$zipcode": "87102"}}
+      %Account{"$user_email": "bob@example.com", "$user_id": "bob", "$type": "$create_account", "$api_key": api_key(), "$billing_address": %Address{"$name": "Bob", "$zipcode": "87102"}}

      iex> Account.create_account(%{user_email: "bob@example.com", user_id: "bob", promotions: [%{promotion_id: "promo"}]})
-      %Account{"$user_email": "bob@example.com", "$user_id": "bob", "$type": "$create_account", "$api_key": api_key, "$promotions": [%Promotion{"$promotion_id": "promo"}]}
+      %Account{"$user_email": "bob@example.com", "$user_id": "bob", "$type": "$create_account", "$api_key": api_key(), "$promotions": [%Promotion{"$promotion_id": "promo"}]}


This was producing compiler warnings.

dereksweet · 2020-11-06T18:44:44Z


  alias Siftsciex.Event.Payload
-  alias Siftsciex.Event.Payload.{Address, Image, Item, Location}
+  alias Siftsciex.Event.Payload.{Address, Image, Item}


This was producing compiler warnings

dereksweet · 2020-11-06T18:44:58Z

-      iex> Response.process(%{"status" => 0, "error_message" => "OK", "time" => time, "request" => ""})
-      %Response{status: 0, message: "OK", time: date_time, request: "", score_response: :empty}
+      iex> Response.process(%{"status" => 0, "error_message" => "OK", "time" => time(), "request" => ""})
+      %Response{status: 0, message: "OK", time: date_time(), request: "", score_response: :empty}


This was producing compiler warnings

dereksweet · 2020-11-06T18:45:06Z

  ## Examples

-      iex> Error.error(response)
+      iex> Error.error(response())


This was producing compiler warnings

dereksweet · 2020-11-06T18:45:29Z

-  def post(_, %{"$user_id": "transport_error"} = data) do
+  def post(_, %{"$user_id": "transport_error"} = _data) do
    {:error, %{reason: "Timeout"}}
  end
-  def post(_, %{"$user_id": "server_error"} = data) do
+  def post(_, %{"$user_id": "server_error"} = _data) do
    {:ok, %{status_code: 500}}
  end
-  def post(_, %{"$user_id": "client_error"} = data) do
+  def post(_, %{"$user_id": "client_error"} = _data) do


This was producing compiler warnings

LeakyBucket · 2020-11-06T18:58:28Z

👋 Hi @dereksweet this is awesome! Unfortunately I'm not with Apartment Therapy any longer, although it looks like @andrewb is maybe he can help out with this? I would love for improvements to make it into the library so everyone can easily use them.

dereksweet · 2020-11-06T19:40:30Z

Sure, thanks for the quick response @LeakyBucket. @andrewb any chance you'd want to merge this? We'd like to get off our local fork to ensure we are up to date with any changes in the future. I'm sure we will be adding more features in the future, as well. Let me know!

andrewb · 2020-11-09T22:13:38Z

@dereksweet thanks for your contribution. Unfortunately our team no longer develops our Elixir codebases so I don't expect any updates to this repo in future.

dereksweet · 2020-11-10T01:48:35Z

@dereksweet thanks for your contribution. Unfortunately our team no longer develops our Elixir codebases so I don't expect any updates to this repo in future.

OK that's fair. How would you feel about passing the torch on to me? I would take it up on my personal account.

dereksweet · 2020-11-19T21:07:02Z

@andrewb I can actually get this merged directly into the SiftSciences organization here: https://github.com/SiftScience

Would you be willing to assist in getting the hexdocs updated to point there instead of at apartmenttherapy?

`__MODULE__.t` on line 27 is cause compilation failures. Adding a union type of the two responses.

Add support for $login event

dereksweet · 2021-03-23T15:03:07Z

@andrewb thought I'd try one more time to ask you about this. Would you be willing to transfer ownership of this project to The RealReal. You can see we've added more support for both login events and now we are adding support for the Decisions API as well. If not we can just keep adding to our fork or make a new package entirely, but if you'd be willing to pass on ownership of this we have a great relationship with the people at Sift and they will add it to their official packages list.

Here is some documentation on how to use the hex.owner mix to transfer ownership: https://hexdocs.pm/hex/Mix.Tasks.Hex.Owner.html

…decisions_api [FUJI-68] Add support for Decisions API

…n deprecated

[FUJI-92] Update the URL used for getting a user's score

…ows-178109577 [#178109577] Synchronous workflow response support

…vents [ZION-661] Better error handling for events

[ZION-691] Evaluate config at runtime

dereksweet added 10 commits August 10, 2020 11:51

Increase update_account event support

6079242

Add support for the following fields for an update_account event - $session_id - update_status

Support Verification API

d27a439

Add support for the Verification API, following 3 endpoints: - /send - /resend - /check

Verification API automated tests

5e3ad60

- Basic automated testing added for the Verification product via doctest - Fixed compiler warnings when running full test suite

Remove incorrect return types

7dc176c

remove unused aliases

97de916

Update README

9a261ea

[#173854267] Add support for Verification product

97602f1

Add support for session_id and verified_event_id

81338f9

Add support for brand name to verification send payload

0e006a9

allow verified_entity_id to be sent with send events

e2861ac

dereksweet commented Nov 6, 2020

View reviewed changes

coryodaniel and others added 10 commits December 2, 2020 12:06

Adding a union type for Response (#2)

d07b0fb

`__MODULE__.t` on line 27 is cause compilation failures. Adding a union type of the two responses.

Add support for $login event

eeeadb9

Bump dependencies

983fb4c

Merge pull request #4 from msramos/mr/session-events

2cdc5ae

Add support for $login event

Update version number and maintainer links

20021bb

All the code to support getting decisions for an entity

aa3d35e

All the supporting tests and mocks

8aa13da

woops use the result type

c03fe0f

remove errant commented code

1140cb2

rename decisions_url to accounts_url because it's more accurate

57d562f

dereksweet and others added 14 commits March 23, 2021 10:10

add support for sessions and content entities as well

7fd278a

Merge pull request #5 from TheRealReal/story/FUJI-68/add_support_for_…

7a463d6

…decisions_api [FUJI-68] Add support for Decisions API

Update the URL used for getting a user's score as the old one has bee…

f2433ef

…n deprecated

update test config as well

42107cf

Merge pull request #6 from TheRealReal/story/FUJI-92/update_scores_url

cb6d21a

[FUJI-92] Update the URL used for getting a user's score

Sync workflows support

51f8033

Merge pull request #7 from TheRealReal/mr/add-support-for-sync-workfl…

8f4935a

…ows-178109577 [#178109577] Synchronous workflow response support

Better error handling for events

18b2c61

Add tests for the new event error module

2ac6c8f

Update result specs for events

65ba974

Fix typo

292ddb0

Merge pull request #8 from TheRealReal/mr/better-error-handling-for-e…

04d2d47

…vents [ZION-661] Better error handling for events

Fix runtime config for events api

73ad5a5

Merge pull request #9 from TheRealReal/mr/fix-runtime-config

9768631

[ZION-691] Evaluate config at runtime

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add support for Sift Verification Product#2

Add support for Sift Verification Product#2
dereksweet wants to merge 34 commits into
apartmenttherapy:masterfrom
TheRealReal:master

dereksweet commented Nov 6, 2020

Uh oh!

dereksweet Nov 6, 2020

Uh oh!

dereksweet Nov 6, 2020

Uh oh!

dereksweet Nov 6, 2020

Uh oh!

dereksweet Nov 6, 2020

Uh oh!

dereksweet Nov 6, 2020

Uh oh!

LeakyBucket commented Nov 6, 2020

Uh oh!

dereksweet commented Nov 6, 2020

Uh oh!

andrewb commented Nov 9, 2020

Uh oh!

dereksweet commented Nov 10, 2020

Uh oh!

dereksweet commented Nov 19, 2020

Uh oh!

dereksweet commented Mar 23, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

dereksweet commented Nov 6, 2020

What does this PR do & why?

How can this be manually tested?

Any questions or concerns about this change?

Deployment Notes

Uh oh!

dereksweet Nov 6, 2020

Choose a reason for hiding this comment

Uh oh!

dereksweet Nov 6, 2020

Choose a reason for hiding this comment

Uh oh!

dereksweet Nov 6, 2020

Choose a reason for hiding this comment

Uh oh!

dereksweet Nov 6, 2020

Choose a reason for hiding this comment

Uh oh!

dereksweet Nov 6, 2020

Choose a reason for hiding this comment

Uh oh!

LeakyBucket commented Nov 6, 2020

Uh oh!

dereksweet commented Nov 6, 2020

Uh oh!

andrewb commented Nov 9, 2020

Uh oh!

dereksweet commented Nov 10, 2020

Uh oh!

dereksweet commented Nov 19, 2020

Uh oh!

dereksweet commented Mar 23, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants