🥔✨👷 `Marketplace`: Transmits orders to `Square` #1733

rosschapman · 2023-08-05T01:30:46Z

🌱✨ Marketplace: Seller receives Order in their Square Point of Sale #1500

Description

TDR (Technical Decision Records)

Put new Square logic on Marketplace::Order. See 🥔✨👷 Marketplace: Transmits orders to Square #1733 (comment).
Won't implement an ersatz feature flag. See https://github.com/zinc-collective/convene/pull/1733/files#r1302266674

Testing

Local QA Trials

8/24/23 - Created multi-product, multi-quantity order
8/23/23 - Successfully created a Square order and payment with the correct vendor share price total with the Stripe processing fee subtracted:
8/18/23 - Successfully created a Square order and payment by invoking the call sequence in with this Stripe CLI command: $ stripe trigger checkout.session.completed. Order shoes in my Sandbox Seller Dashboard:

zspencer

This looks like it's on the right track! I also added Support for Bust a Gem so that you don't have to manually un-stage your TAGS file.

app/furniture/marketplace/marketplace.rb

app/furniture/marketplace/stripe_events_controller.rb

zspencer · 2023-08-18T22:47:02Z

.env.example

@@ -31,3 +31,6 @@ OPERATOR_API_KEY=a-secret-that-should-get-changed
 STRIPE_API_KEY=get-this-from-your-stripe-account

 NEIGHBORHOOD_TIME_ZONE="Pacific Time (US & Canada)"
+
+# Configure Square environment
+# SQUARE_ENV="production"|"sandbox"


This probably should be set in the Marketplace for now, rather than a global variable.

zspencer

It's on a good path; I would be happy for us to merge this if:

We get rid of the global variable storing sandbox vs production
It did not include the TAGS or the change to launch.json
It had some amount of tests. I'm happy to pair on writing the tests; or do a branch-off-your-branch and submit a patch with some tests.

app/furniture/marketplace/order.rb

zspencer · 2023-08-18T22:50:02Z

app/furniture/marketplace/order.rb

+        square_order_id,
+        square_location_id,
+        space_id,
+        # TODO: what should be canonical pricing data here: stripe_balance_transaction or order data?


I would expect this to be the sellers_share of the order; not the full balance or order amount.

app/furniture/marketplace/stripe_events_controller.rb

zspencer · 2023-08-18T22:51:34Z

app/furniture/marketplace/stripe_events_controller.rb

        Order::ReceivedMailer.notification(order).deliver_later
        order.events.create(description: "Notifications to Vendor and Distributor Sent")
        Order::PlacedMailer.notification(order).deliver_later
        order.events.create(description: "Notification to Buyer Sent")

        SplitJob.perform_later(order: order)
      else
-        raise UnexpectedStripeEventTypeError, event.type
+        # raise UnexpectedStripeEventTypeError, event.type


This probably should still be there, no?

zspencer · 2023-08-18T22:51:51Z

.vscode/launch.json

-      "script": "${file}",
-      "args": [],
-      "askParameters": true
-    },


Is removing this part of doing Square stuff? Or is it incidental?

Oh not sure what happened here. Oops.

app/furniture/marketplace/marketplace.rb

rosschapman · 2023-08-23T00:57:52Z

app/furniture/marketplace/order.rb

+      location_id = marketplace.settings["square_location_id"]
+      customer_id = shopper.id
+
+      stripe_fee_per_line_item = (payment_processor_fee_cents / ordered_products.sum(&:quantity))


@zspencer @anaulin I can't tell if this is tacky or not, but it quickly felt like the best way to make sure line items are separated in the Square order and the vendor share total is accurately calculated. From the PoV of the seller in their Square dashboard, they don't see this line item level fee. It merely comes in as the price total.

This calculation feels like a dangerous idea from a book-keeping perspective. They are selling the product for $10, not $10 - a_fraction_of_the_stripe_fees.

Yeah I figured as much. There's gotta be a better way around this. Square seems to compute and validate the line item total generated during order creation against the payment total during payment creation. If they don't match, the payment fails.

The trick is to have the vendor/seller line items appear with the correct amounts. Need to think on this more. It could be we add a negative service charge with the order creation data for the Stripe fee. But I'm not sure sellers are supposed to be aware of the Stripe fee?

Can we tell Square that the Payment is for the total?

rosschapman · 2023-08-23T00:58:54Z

app/furniture/marketplace/order.rb

+          quantity: ordered_product.quantity.to_s,
+          item_type: "ITEM", # ITEM|CUSTOM_AMOUNT|CGI
+          base_price_money: {
+            amount: (ordered_product.price_cents - stripe_fee_per_line_item),


See: https://github.com/zinc-collective/convene/pull/1733/files#r1302335489

zspencer

This is looking pretty good!

A few things:

Why is TAGS checked in here?
My gut says we should be passing the full amounts directly through; and not doing any kind of fee-deductions. The PoS doesn't need to know about payment-processor fees; just how much money we collected on their behalf. It's not like a sandwhich that costs $10 is registered as sold at "$9.08" by the PoS because someone used MasterCard and $9.15 because someone else used Visa...

That said, I am down to approve this once the TAGS are deleted because I could be 100% wrong and I would rather we move towards prod and learn.

zspencer · 2023-08-23T20:20:44Z

app/furniture/marketplace/marketplace.rb

+    def square_environment
+      if Rails.env.production?
+        "production"
+      end


I would prefer if this was a value stored in the Marketplace; since we do need to be able to use the sandbox environment in a Rails production context.

Even if we don't make it to the UI; it does not seem appropriate to flag based upon deployment environment.

I may have misinterpreted your earlier feedback as put on marketplace model for some reason. Oof, tough getting used to jumping in and out of a codebase on limited time!

Well, this is definitely the right place for it in our current domain model; it's just not quite how I would decide whether it's prod or not.

And yea, the "put work down and pick it back up in narrow time windows" is a hard skill!

zspencer · 2023-08-23T20:24:16Z

app/furniture/marketplace/order.rb

+      location_id = marketplace.settings["square_location_id"]
+      customer_id = shopper.id
+
+      stripe_fee_per_line_item = (payment_processor_fee_cents / ordered_products.sum(&:quantity))


This calculation feels like a dangerous idea from a book-keeping perspective. They are selling the product for $10, not $10 - a_fraction_of_the_stripe_fees.

app/furniture/marketplace/order.rb

zspencer · 2023-08-24T20:37:53Z

app/furniture/marketplace/order.rb

+
+    # TODO: Add `square_environment` attribute to database/model
+    def square_client
+      @square_client ||= Square::Client.new(access_token: marketplace.square_access_token, environment: marketplace.square_environment)


Since we're reading data from the marketplace to create the square_client, that implies to me that it maybe wants to live on the marketplace, and the Order class can delegate :square_client, to: :marketplace?

zspencer · 2023-08-24T20:39:02Z

app/furniture/marketplace/stripe_events_controller.rb

@@ -24,6 +23,10 @@ def create
        order.update!(status: :paid, placed_at: DateTime.now, payment_processor_fee_cents: balance_transaction.fee)
        order.events.create(description: "Payment Received")

+        if marketplace.square_order_notifications_enabled?
+          order.send_to_square_seller_dashboard


Thoughts on encapsulating this conditional within the method? Basically, Order#send_to_square_seller_dashboard is a no-op if marketplace.square_order_notifications_enabled? is false.

zspencer

Ship it!

rosschapman changed the base branch from main to adds-encrypted-configuration-to-furniture August 5, 2023 01:31

Checkpoint: adds square api calls and data builders

b6e9e60

rosschapman force-pushed the adds-placeholders-square-order-creation branch from a0d9535 to b6e9e60 Compare August 5, 2023 01:32

Base automatically changed from adds-encrypted-configuration-to-furniture to main August 8, 2023 15:34

rosschapman added 2 commits August 9, 2023 10:32

Merge branch 'main' into adds-placeholders-square-order-creation

8370aeb

Updates comments

4615ccc

zspencer reviewed Aug 9, 2023

View reviewed changes

app/furniture/marketplace/marketplace.rb Show resolved Hide resolved

app/furniture/marketplace/stripe_events_controller.rb Outdated Show resolved Hide resolved

rosschapman added 8 commits August 13, 2023 14:02

Merge branch 'main' into adds-placeholders-square-order-creation

aba24a0

Updates param builders

0d33594

Merge branch 'main' into adds-placeholders-square-order-creation

35a6f32

Moves calls to Marketplace::Order

d48e485

Further updates to Marketplace::Order

1cbc21b

Undo rubocop change

256176e

Pass stripe balance transaction param

f4770fd

Adds some todos

63cc256

rosschapman changed the title ~~👷‍♀️ Adds placeholders for Square Order Notification pipeline~~ 👷‍♀️ Adds logic for Square Order Notification pipeline Aug 18, 2023

rosschapman requested a review from zspencer August 18, 2023 21:08

Updates flag

33488c5

zspencer reviewed Aug 18, 2023

View reviewed changes

rosschapman added 3 commits August 18, 2023 18:02

Uncomments line

85406a3

Inline vars and privatize methods

35d1bbb

Move sq environment to Marketplace, sundries

a7932b8

rosschapman commented Aug 19, 2023

View reviewed changes

app/furniture/marketplace/marketplace.rb Outdated Show resolved Hide resolved

rosschapman added 3 commits August 19, 2023 11:19

Update app/furniture/marketplace/marketplace.rb

5a25e85

Fixes pricing to account for fee

27c1e55

Uses line item total for pricing instead of fancy stuff?

ea6e470

rosschapman commented Aug 23, 2023

View reviewed changes

Abstract idemp key

4218c68

Adds comment

8d9cc89

rosschapman requested a review from zspencer August 23, 2023 01:05

zspencer reviewed Aug 23, 2023

View reviewed changes

zspencer changed the title ~~👷‍♀️ Adds logic for Square Order Notification pipeline~~ 🥔✨ Marketplace: Transmits orders to Square Aug 23, 2023

zspencer changed the title ~~🥔✨ Marketplace: Transmits orders to Square~~ 🥔✨👷 Marketplace: Transmits orders to Square Aug 23, 2023

rosschapman added 4 commits August 24, 2023 11:46

Removes payment fee subtraction from totals

6baa893

Removes errant TAGS -- need to merge main?

b3a9e8f

Updates unit price for square order

e56ea57

Removes comments

052453b

rosschapman force-pushed the adds-placeholders-square-order-creation branch from cd3bb2a to 052453b Compare August 24, 2023 19:38

rosschapman commented Aug 24, 2023

View reviewed changes

app/furniture/marketplace/order.rb Outdated Show resolved Hide resolved

rosschapman added 2 commits August 24, 2023 12:39

Adds comment

8e1b67d

Removes comments

3b35b16

rosschapman marked this pull request as ready for review August 24, 2023 19:45

Fixes style

bccd4d2

zspencer reviewed Aug 24, 2023

View reviewed changes

zspencer approved these changes Aug 24, 2023

View reviewed changes

Move sq client to marketplace

c5febb7

rosschapman merged commit 8505a83 into main Aug 28, 2023

rosschapman deleted the adds-placeholders-square-order-creation branch August 28, 2023 18:06

rosschapman mentioned this pull request Oct 31, 2023

👷 Refactors existing Square logic to a new SquareOrder service class #1909

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🥔✨👷 `Marketplace`: Transmits orders to `Square` #1733

🥔✨👷 `Marketplace`: Transmits orders to `Square` #1733

rosschapman commented Aug 5, 2023 •

edited

Loading

zspencer left a comment

zspencer Aug 18, 2023

zspencer left a comment

zspencer Aug 18, 2023

zspencer Aug 18, 2023

rosschapman Aug 19, 2023

zspencer Aug 18, 2023

rosschapman Aug 19, 2023

rosschapman Aug 23, 2023 •

edited

Loading

zspencer Aug 23, 2023

rosschapman Aug 24, 2023

zspencer Aug 24, 2023

rosschapman Aug 23, 2023

zspencer left a comment

zspencer Aug 23, 2023

rosschapman Aug 24, 2023

zspencer Aug 24, 2023

zspencer Aug 23, 2023

zspencer Aug 24, 2023

zspencer Aug 24, 2023

zspencer left a comment

🥔✨👷 Marketplace: Transmits orders to Square #1733

🥔✨👷 Marketplace: Transmits orders to Square #1733

Conversation

rosschapman commented Aug 5, 2023 • edited Loading

Description

TDR (Technical Decision Records)

Testing

Local QA Trials

zspencer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zspencer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rosschapman Aug 23, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zspencer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zspencer left a comment

Choose a reason for hiding this comment

🥔✨👷 `Marketplace`: Transmits orders to `Square` #1733

🥔✨👷 `Marketplace`: Transmits orders to `Square` #1733

rosschapman commented Aug 5, 2023 •

edited

Loading

rosschapman Aug 23, 2023 •

edited

Loading