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

rosschapman · 2023-10-26T01:14:21Z

Issue

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

Goals

Add additional test coverage for a Guest checkout
The new class should expose a single public method for executing the workflow to create an order in square. For example, from inside stripe_events_controller.rb or elsewhere
```
square_order = SquareOrder.new(order, ???)
square_order.send_to_square_seller_dashboard
```

Notes

🙋 What initial data does a SquareOrder instance need to do it's work?
- order, marketplace, ordered_products
- just an order should suffice to query all necessary data

rosschapman · 2023-10-31T03:20:14Z

app/furniture/marketplace/order.rb

Relocates all Square related behavior to the new Marketplace::SquareOrder class.

app/furniture/marketplace/square_order.rb

rosschapman · 2023-10-31T03:28:48Z

spec/factories/furniture/marketplace.rb

This sketches the use of live sandbox credentials for e2e testing.

rosschapman · 2023-10-31T03:31:23Z

spec/furniture/marketplace/square_order_spec.rb

Sketches of unit tests for complex internal methods of the new SquareOrder service class. I'm thinking about this class in a way similar to an external library, therefore it feels justified to test complex private methods that are critical to the correct transmission of data.

spec/furniture/marketplace/stripe_events_controller_request_spec.rb

app/furniture/marketplace/stripe_events_controller.rb

zspencer

I like where this is headed! Just not approving because it's still in draft.

Can't wait to see the tests!

app/furniture/marketplace/stripe_events_controller.rb

app/furniture/marketplace/square_order.rb

zspencer · 2023-10-31T19:21:19Z

app/furniture/marketplace/square_order.rb

+    private def create_square_order_payment
+      square_create_payment_body = prepare_square_create_order_payment_body
+
+      marketplace.square_client.payments.create_payment(body: square_create_payment_body)


Same here, just for shits and giggles.

zspencer

I've added the credentials for a Zinc Collective LLC Square Account and read through the code.

I think this is a good enough step forward; and left some stylistic feedback around:

Using delegate and attr_accessor to reduce the amount of setup on class instantiation
Including more context when sending information to the Square POS
Storing significant events (Square Order, etc) in the database so that they are visible to the Marketplace Vendor and Distributor; rather than just developers.

app/furniture/marketplace/square_order.rb

zspencer · 2023-11-12T17:53:40Z

app/furniture/marketplace/square_order.rb

+    # receiving account which are requirements for the order to show up in the
+    # Seller Dashboard.
+    def send_order
+      Rails.logger.info("Start creating Square order")


Loggers are great! But what I really want are events attached to the Order so that we can surface the information to the folks at Piikup:

convene/app/furniture/marketplace/stripe_events_controller.rb

Line 24 in 5ab1916

order.events.create(description: "Payment Received")

Ah ok. A blend of misinterpreting your guidance and forgetting we had an event system implemented. Let's do it. Although I'm interested in keeping the logs around for our own benefit.

@zspencer

What's the thinking around what strings go into the public.marketplace_events.description column since it's a "free" text type? Understandably with a small org code review serves as a guardrail to maintain consistent event descriptions/actions. But would the list of accepted descriptions strings be something we would consider declaring in some kind of enum somewhere so developers could easily consult an existing set?

I already notice we use a typical pattern of Title Case, past tense, and Noun + Verb. What about adding a small style guide comment to the Event model?

I think a style guide is probably better than an enum; but if you want to gather the usages I wouldn't be opposed.

zspencer · 2023-11-12T17:55:57Z

spec/furniture/marketplace/stripe_events_controller_request_spec.rb

      end
    end

    context "when Square notifications are enabled" do
-      let(:order) { order_for_square }
+      let(:marketplace) { create_marketplace_with_square }


Rather than a unique way to create data, it may be better to use FactoryBot's trait system and create(:marketplace, :with_square)

Will follow up in #1936

zspencer · 2023-11-12T18:19:38Z

spec/factories/furniture/marketplace.rb

@@ -65,6 +65,14 @@
      with_delivery_areas
      with_notification_methods
    end
+
+    trait :with_square do


Is there supposed to be an Application ID? I'm adding secrets to Github and I've added:

MARKETPLACE_VENDOR_SQUARE_ACCESS_TOKEN

MARKETPLACE_VENDOR_SQUARE_LOCATION

SQUARE_ENV

MARKETPLACE_DISTRIBUTOR_APPLICATION_ID

I think the application id is only important if we make it an OAUTH App; which I would love for us to do at some point (so that someone can just add "Delivery by Piikup" to their Square account and magic-pony complete!)

It's not necessary for instantiating a Square Client class.

app/furniture/marketplace/square_order.rb

zspencer · 2023-11-12T18:34:51Z

app/furniture/marketplace/stripe_events_controller.rb

-        if marketplace.square_order_notifications_enabled?
-          order.send_to_square_seller_dashboard
-        end
+        marketplace.square_connection&.send_order


It is. Although I'd still prefer a more object-oriented, explicit exposure and/or handling of nil cases. 😅

rosschapman · 2023-11-13T21:08:35Z

@zspencer I'm going to follow up with a separate PR for the tests to reduce noise in this PR. See #1936. Therefore consider what's already here ready for any final review. I suspect it may not be perfect so we can also work out some details on the next PR if required.

zspencer

Once you get the tests passing let's shipit!

Checkpoint

7cf8c09

rosschapman changed the title ~~Checkpoint~~ Refactors Square logic from StripeEventsController to a new SquareOrder service class Oct 26, 2023

rosschapman changed the title ~~Refactors Square logic from StripeEventsController to a new SquareOrder service class~~ 👷 Refactors Square logic from StripeEventsController to a new SquareOrder service class Oct 26, 2023

rosschapman added 8 commits October 27, 2023 19:00

Updates initialization and tests

2c379dc

Renames spec path

5cc3b88

Oops remove test env

ca1b154

Adds another expectation

81567e9

Updates initialization

1699ee5

Merge branch 'main' into marketplace-square-order-model

37ac3e2

Updates tests

178ef2d

Updates tests

5f1b942

rosschapman commented Oct 31, 2023

View reviewed changes

Updates comment

439e60d

rosschapman commented Oct 31, 2023

View reviewed changes

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

rosschapman commented Oct 31, 2023

View reviewed changes

spec/furniture/marketplace/stripe_events_controller_request_spec.rb Show resolved Hide resolved

rosschapman commented Oct 31, 2023

View reviewed changes

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

Update app/furniture/marketplace/stripe_events_controller.rb

8fddcd4

zspencer reviewed Oct 31, 2023

View reviewed changes

rosschapman changed the title ~~👷 Refactors Square logic from StripeEventsController to a new SquareOrder service class~~ 👷 Refactors existing Square logic to a new SquareOrder service class Oct 31, 2023

dependabot bot and others added 9 commits November 1, 2023 10:11

Bump @sentry/browser from 7.75.1 to 7.76.0 (#1913)

07cb4cd

Bump rubocop-rspec from 2.24.1 to 2.25.0 (#1912)

d2f25cf

Bump rubocop-rails from 2.21.2 to 2.22.0 (#1911)

76c5522

Bump axios from 1.5.1 to 1.6.0 (#1910)

7d9f946

Bump view_component from 3.6.0 to 3.7.0 (#1915)

0bb1eda

Bump bootsnap from 1.16.0 to 1.17.0 (#1916)

cf442cd

Bump rubocop-rails from 2.22.0 to 2.22.1 (#1914)

860bf36

OOP send order

f172166

Merge branch 'main' into marketplace-square-order-model

b6b4374

rosschapman added 4 commits November 1, 2023 16:29

OOP send order

4f7eb86

Adds todos and loggers

a18889b

Updates comment

717b9e1

Adds expectations on loggers in test

76a2b7b

rosschapman marked this pull request as ready for review November 9, 2023 19:25

rosschapman added 2 commits November 9, 2023 11:29

Updates class constant

bf846a3

Updates method name

d2e0d7b

zspencer reviewed Nov 12, 2023

View reviewed changes

rosschapman added 2 commits November 13, 2023 12:47

Minor style updates

8ef87f0

Removes tests

eed0a72

rosschapman mentioned this pull request Nov 13, 2023

🥗 Marketplace: Test Seller receives Order in their Square Point of Sale #1936

Merged

rosschapman requested a review from zspencer November 13, 2023 21:08

Merge branch 'main' into marketplace-square-order-model

390a2d6

zspencer approved these changes Nov 14, 2023

View reviewed changes

Removes bad test

32bd533

rosschapman merged commit f728ea5 into main Nov 17, 2023

rosschapman deleted the marketplace-square-order-model branch November 17, 2023 01:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

rosschapman commented Oct 26, 2023 •

edited

Loading

rosschapman Oct 31, 2023

rosschapman Oct 31, 2023 •

edited

Loading

rosschapman Oct 31, 2023

zspencer left a comment

zspencer Oct 31, 2023

zspencer left a comment

zspencer Nov 12, 2023

rosschapman Nov 13, 2023 •

edited

Loading

rosschapman Nov 13, 2023

zspencer Nov 14, 2023

zspencer Nov 12, 2023

rosschapman Nov 13, 2023

zspencer Nov 12, 2023

zspencer Nov 12, 2023

rosschapman Nov 13, 2023

zspencer Nov 12, 2023

rosschapman Nov 13, 2023

rosschapman commented Nov 13, 2023

zspencer left a comment

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

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

Conversation

rosschapman commented Oct 26, 2023 • edited Loading

Issue

Goals

Notes

Choose a reason for hiding this comment

rosschapman Oct 31, 2023 • edited Loading

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

zspencer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rosschapman Nov 13, 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

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 commented Nov 13, 2023

zspencer left a comment

Choose a reason for hiding this comment

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

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

rosschapman commented Oct 26, 2023 •

edited

Loading

rosschapman Oct 31, 2023 •

edited

Loading

rosschapman Nov 13, 2023 •

edited

Loading