Spree Commerce hub - technical summary

Transcript

1. Spree Commerce hub
2. Spree Commerce hub Overview
3. Spree Commerce store front Spree Commerce hub Overview
4. Spree Commerce store front Spree Commerce hub Overview
5. Spree Commerce store front Spree Commerce hub Mandrill NetSuite Shipwire Custom Overview
6. Spree Commerce store front Spree Commerce hub Mandrill NetSuite Shipwire Custom SendGrid Xero Amazon Custom So Ne E Cu Overview
7. Store front hub Mandrill Endpoint Overview
8. Store front hub orders updated since (timestamp) updated orders Mandrill Endpoint Overview
9. Store front hub orders updated since (timestamp) updated orders Mandrill Endpoint detect new orders Overview
10. Store front hub orders updated since (timestamp) updated orders Mandrill Endpoint send order confirmation email detect new orders confirmation Overview
11. Store front hub orders updated since (timestamp) updated orders confirmation Overview
12. Store front hub orders updated since (timestamp) updated orders send shipment to fulfillment detect ready shipments confirmation Shipwire Endpoint Overview
13. Store front hub Shipwire Endpoint Overview
14. Store front hub poll for shipments (bookmark) dispatched shipments Shipwire Endpoint Overview
15. Store front hub poll for shipments (bookmark) dispatched shipments Shipwire Endpoint update shipment state + tracking confirmation Overview
16. Store front hub poll for shipments (bookmark) dispatched shipments Shipwire Endpoint update shipment state + tracking confirmation Overview
17. hub poll for shipments (bookmark) dispatched shipments Shipwire Endpoint + tracking Mandrill Endpoint Overview
18. hub poll for shipments (bookmark) dispatched shipments Shipwire Endpoint + tracking Mandrill Endpoint Overview
19. hub poll for shipments (bookmark) dispatched shipments Shipwire Endpoint + tracking Mandrill Endpoint send shipment notification email Overview
20. hub poll for shipments (bookmark) dispatched shipments Shipwire Endpoint + tracking Mandrill Endpoint send shipment notification email confirmation Overview
21. Message Basics
22. JSON
23. Message: Overview 1 { 2 "message": "payment:ready", 3 "payload": { 4 "payment": { 5 "id": 15913, 6 "amount": "129.57", 7 "state": "pending", 8 "payment_method": { 9 "id": 931422127, 10 "name": "Credit Card", 11 "environment": "production" 12 } 13 } 14 } 15 }
24. Message: Overview 1 { 2 "message": "payment:ready", 3 "payload": { 4 "payment": { 5 "id": 15913, 6 "amount": "129.57", 7 "state": "pending", 8 "payment_method": { 9 "id": 931422127, 10 "name": "Credit Card", 11 "environment": "production" 12 } 13 } 14 } 15 }
25. Message: Overview 1 { 2 "message": "payment:ready", 3 "payload": { 4 "payment": { 5 "id": 15913, 6 "amount": "129.57", 7 "state": "pending", 8 "payment_method": { 9 "id": 931422127, 10 "name": "Credit Card", 11 "environment": "production" 12 } 13 } 14 } 15 }
26. message:
27. Order New order:new Order Updated order:updated Order Cancelled order:cancelled
28. Order New order:new Order Updated order:updated Order Cancelled order:cancelled Shipment Confirmation shipment:confirm Shipment Ready shipment:ready
29. Order New order:new Order Updated order:updated Order Cancelled order:cancelled Payment Ready payment:ready Shipment Confirmation shipment:confirm Shipment Ready shipment:ready Payment Captured payment:captured Payment Declined payment:declined
30. 1 { 2 "message_id": "518783ac7575e46507000001", 3 "message": "payment:ready", 4 "payload": { ... }, 5 "parameters": [ 6 { 7 "name": "quickbooks.user_name", 8 "value": "iQ55k..." 9 }, 10 { 11 "name": "quickbooks.password", 12 "value": "YQoQS..." 13 } 14 ] 15 } Message: Parameters
31. 1 { 2 "message_id": "518783ac7575e46507000001", 3 "message": "payment:ready", 4 "payload": { ... }, 5 "parameters": [ 6 { 7 "name": "quickbooks.user_name", 8 "value": "iQ55k..." 9 }, 10 { 11 "name": "quickbooks.password", 12 "value": "YQoQS..." 13 } 14 ] 15 } Message: Parameters
32. Message Flow
33. MSG Message Flow
34. MSG Incoming Queue Message Flow
35. MSG Incoming Queue Router Message Flow
36. MSG Incoming Queue Router Message Flow
37. MSG Incoming Queue Router Consumer Registry Message Flow
38. MSG Incoming Queue Router Consumer Registry Accepted Queue Message Flow
39. order:new MSG Incoming Queue Router Consumer Registry Accepted Queue Message Flow
40. order:new 1 x order:new MSG Incoming Queue Router Consumer Registry Accepted Queue Message Flow
41. order:new 1 x order:new order:new - Mandrill - NetSuite - MixPanel MSG Incoming Queue Router Consumer Registry Accepted Queue Message Flow
42. order:new 1 x order:new order:new - Mandrill - NetSuite - MixPanel 3 x order:new - Mandrill - NetSuite - MixPanel MSG Incoming Queue Router Consumer Registry Accepted Queue Message Flow
43. Accepted Queue 3 x order:new - Mandrill - NetSuite - MixPanel Message Flow
44. Accepted Queue Dispatcher 3 x order:new - Mandrill - NetSuite - MixPanel Message Flow
45. Accepted Queue Dispatcher 3 x order:new - Mandrill - NetSuite - MixPanel Message Flow
46. Accepted Queue Dispatcher Mandrill order:new 1 MixPanel order:new 3 NetSuite order:new 2 3 x order:new - Mandrill - NetSuite - MixPanel Message Flow
47. Accepted Queue Dispatcher Mandrill order:new 1 MixPanel order:new 3 NetSuite order:new 2 200: success 200: success 3 x order:new - Mandrill - NetSuite - MixPanel Message Flow
48. Accepted Queue Dispatcher Mandrill order:new 1 MixPanel order:new 3 NetSuite order:new 2 200: success 200: success 3 x order:new - Mandrill - NetSuite - MixPanel Message Flow
49. Accepted Queue Dispatcher Mandrill order:new 1 MixPanel order:new 3 NetSuite order:new 2 200: success 200: success 500: fail! 3 x order:new - Mandrill - NetSuite - MixPanel Message Flow
50. Accepted Queue Dispatcher NetSuite 1 x order:new - NetSuite Message Flow
51. Accepted Queue Dispatcher NetSuite order:new 2 500: fail! 1 x order:new - NetSuite order:new 2 500: fail! order:new 2 500: fail! order:new 2 200: success Message Flow
52. Accepted Queue Dispatcher NetSuite order:new 2 500: fail! 1 x order:new - NetSuite order:new 2 500: fail! order:new 2 500: fail! order:new 2 200: success Message Flow
53. Benefits
54. Versioned
55. Order V1 parent: null new Versioning
56. Order V1 parent: null new send order confirmation email Versioning
57. Order V1 parent: null Order V2 parent: V1 update new send order confirmation email Versioning
58. Order V1 parent: null Order V2 parent: V1 update new send order confirmation email capture payment Versioning
59. Order V1 parent: null Order V2 parent: V1 update new Order V3 parent: V2 update send order confirmation email capture payment Versioning
60. Order V1 parent: null Order V2 parent: V1 update new Order V3 parent: V2 update send order confirmation email capture payment send shipment to fulfillment Versioning
61. Order V1 parent: null Order V2 parent: V1 update new Order V3 parent: V2 update update Order V4 parent: V3 send order confirmation email capture payment send shipment to fulfillment Versioning
62. Order V1 parent: null Order V2 parent: V1 update new Order V3 parent: V2 update update Order V4 parent: V3 send order confirmation email capture payment send shipment to fulfillment send shipment confirmation Versioning
63. Versioning Implying events
64. Order V1 state: complete Versioning
65. Order V1 state: complete update Order V2 state: canceled Versioning
66. Order V1 state: complete update Order V2 state: canceled push message order:update Versioning
67. Order V1 state: complete update Order V2 state: canceled order:canceled push message order:update Versioning
68. Logged
69. Messages (8)
70. Messages (10)
71. Managed
72. Custom Endpoints
73. HTTP
74. Message: message_id 1 { 2 "message_id": "518783ac7575e46507000001", 3 "message": "payment:ready", 4 "payload": { 5 "payment": { 6 "id": 15913, 7 "amount": "129.57", 8 "state": "pending", 9 "payment_method": { 10 "id": 931422127, 11 "name": "Credit Card", 12 "environment": "production" 13 } 14 } 15 } 16 }
75. Message: message_id 1 { 2 "message_id": "518783ac7575e46507000001", 3 "message": "payment:ready", 4 "payload": { 5 "payment": { 6 "id": 15913, 7 "amount": "129.57", 8 "state": "pending", 9 "payment_method": { 10 "id": 931422127, 11 "name": "Credit Card", 12 "environment": "production" 13 } 14 } 15 } 16 }
76. Dispatcher Endpoint order:new
77. Dispatcher Endpoint POST JSON { ... } order:new
78. Dispatcher Endpoint {message_id: x} HTTP: 200 POST JSON { ... } order:new
79. Dispatcher Endpoint {message_id: x} HTTP: 200 POST JSON { ... } order:new --------------- ✓
80. Response: Basic 1 { 2 "message_id": "518783ac7575e46507000001" 3 }
81. Endpoint: Sinatra 1 require 'sinatra' 2 require 'sinatra/json' 3 4 class SimpleEndpoint < Sinatra::Base 5 helpers Sinatra::JSON 6 7 post '/' do 8 message = JSON.parse(request.body.read) 9 10 json 'message_id' => message['message_id'] 11 end 12 end
82. Endpoint: Sinatra 1 require 'sinatra' 2 require 'sinatra/json' 3 4 class SimpleEndpoint < Sinatra::Base 5 helpers Sinatra::JSON 6 7 post '/' do 8 message = JSON.parse(request.body.read) 9 10 json 'message_id' => message['message_id'] 11 end 12 end
83. Endpoint: Sinatra 1 require 'sinatra' 2 require 'sinatra/json' 3 4 class SimpleEndpoint < Sinatra::Base 5 helpers Sinatra::JSON 6 7 post '/' do 8 message = JSON.parse(request.body.read) 9 10 json 'message_id' => message['message_id'] 11 end 12 end <- DO INTERESTING THINGS HERE
84. Endpoint Base https://github.com/spree/endpoint_base
85. Example: Endpoint Base 1 class SimpleEndpoint < EndpointBase 2 post '/' do 3 process_result 200, {'message_id' => @message['message_id'] } 4 end 5 end
86. 1 { 2 "message_id": "518783ac7575e46507000001", 3 "notifications": [ 4 { "level": "info", 5 "subject": "Shipment accepted", 6 "description": "Shipment H123456 was accepted by 3PL" 7 } 8 ], 9 } Response: Notifications
87. 1 { 2 "message_id": "518783ac7575e46507000001", 3 "notifications": [ 4 { "level": "info", 5 "subject": "Shipment accepted", 6 "description": "Shipment H123456 was accepted by 3PL" 7 } 8 ], 9 } Response: Notifications
89. 1 { 2 "message_id": "518783ac7575e46507000001", 3 "notifications": [{"level": "info", "subject": "it happened"}], 4 "messages": [ 5 { 6 "message": "payment:captured", 7 "payload": { 8 “amount": 129.99, 9 } 10 } 11 ] 12 } Response: Messages
90. 1 { 2 "message_id": "518783ac7575e46507000001", 3 "notifications": [{"level": "info", "subject": "it happened"}], 4 "messages": [ 5 { 6 "message": "payment:captured", 7 "payload": { 8 “amount": 129.99, 9 } 10 } 11 ] 12 } Response: Messages