Ellington Intro

An introduction to Ruby's Ellington framework.

Transcript

1. ELLINGTON
2. A FLOW BASED FRAMEWORK for BPM - Business Process Modeling
3. NO FLO... MEH
4. WHY?
5. TO AVOID THIS
6. AND THIS
7. IMPROVE THIS
8. ENABLE THIS
9. GUARD AGAINST THIS
10. • Establish constraints to ensure that complex projects are easy to manage, develop, and maintain. • Provide a nomenclature simple enough to be shared by engineering and the business team. GOALS
11. WHAT?
12. TAKE THE A TRAIN
13. • Based on New York City’s subway system. • Establishes consistent physical metaphors. • Allows more people to participate. • Manages complexity with simplicity. NOMENCLATURE
15. • Passenger • Station • Line • Route • Ticket • Conductor LEXICON ALMOST SELF EXPLANATORY
16. PASSENGER • The object that acts as the traveler • Has a state property • This state is changed exactly once at each station • Stateful
17. PASSENGER EXAMPLES • Hash • PORO • ActiveRecord • Complex Objects
18. STATION • Where passengers exit • Where business logic lives • Three possible outcomes • PASS • FAIL • ERROR
19. STATION EXAMPLES • Validate data • Persist data • Read/write file • Send email
20. LINE • Moves passengers from point A to point B • A list of Stations • Executed in linear order • Three possible outcomes • PASS • FAIL • ERROR
21. LINE EXAMPLES • Make API call • Generate invoice • Transact payment • Schedule shipment
22. ROUTE • A collection of Lines • Connects lines in non-linear order • Three possible outcomes • PASS • FAIL • ERROR
23. ROUTE EXAMPLES • Process Order • Monetize lead • Exchange data • Approve loan
24. TICKET • Optional • Issued to a passenger • Qualifies the passenger to ride... e.g. security
25. CONDUCTOR • Manages a single route • Responsible for putting passengers on a route • Verifies passengers
26. • Target - a list of states (i.e. to specify a Goal) • Connection - a configuration that ties 2 lines together • Transition - the process of changing a passenger’s state OTHER TERMS
27. HOW?
28. GETTING STARTED • Model business requirements into a simple flow chart • Forces analysis and encourages better design • Allows non-developers to participate
29. A CONTRIVED EXAMPLE
30. • Send a status update to Facebook & Twitter then bill the user • Always try to post to both networks • Only post to a network when certain conditions permit • Only bill if we successfully post to both networks SOCIAL BLAST
31. Social Blast Facebook Verify Token Bill Pass Can Post Should Post Verify Credit Card Bill Credit Card Send Notification Post Twitter Verify Token Can Post Should Post Post Facbook Goal Met? Fail Pass Updated both networks? Finish Fail Start
32. STATION
33. class VerifyFacebookToken < Ellington::Station def engage(user, options) begin # TODO: Verify the OAuth token for the user's Facebook account. # Add some fakery so it feels like its working. raise if rand(100) == 0 ok = rand(100) > 5 if ok pass_passenger user else fail_passenger user end rescue error_passenger user end end end
34. class VerifyFacebookToken < Ellington::Station def engage(user, options) begin # TODO: Verify the OAuth token for the user's Facebook account. # Add some fakery so it feels like its working. raise if rand(100) == 0 ok = rand(100) > 5 if ok pass_passenger user else fail_passenger user end rescue error_passenger user end end end
35. class VerifyFacebookToken < Ellington::Station def engage(user, options) begin # TODO: Verify the OAuth token for the user's Facebook account. # Add some fakery so it feels like its working. raise if rand(100) == 0 ok = rand(100) > 5 if ok pass_passenger user else fail_passenger user end rescue error_passenger user end end end
36. class VerifyFacebookToken < Ellington::Station def engage(user, options) begin # TODO: Verify the OAuth token for the user's Facebook account. # Add some fakery so it feels like its working. raise if rand(100) == 0 ok = rand(100) > 5 if ok pass_passenger user else fail_passenger user end rescue error_passenger user end end end
37. LINE
38. class Facebook < Ellington::Line stations << VerifyFacebookToken.new stations << CanPost.new stations << ShouldPost.new stations << Post.new goal stations.last.passed end
39. class Facebook < Ellington::Line stations << VerifyFacebookToken.new stations << CanPost.new stations << ShouldPost.new stations << Post.new goal stations.last.passed end
40. class Facebook < Ellington::Line stations << VerifyFacebookToken.new stations << CanPost.new stations << ShouldPost.new stations << Post.new goal stations.last.passed end
41. class Facebook < Ellington::Line stations << VerifyFacebookToken.new stations << CanPost.new stations << ShouldPost.new stations << Post.new goal stations.last.passed end
42. ROUTE
43. class Blast < Ellington::Route facebook = Facebook.new twitter = Twitter.new billing = Billing.new lines << facebook # entry line since its the first added lines << twitter lines << billing connect_to twitter, :if_any => [facebook.passed, facebook.failed, facebook.errored] connect_to billing, :if_all => [facebook.passed, twitter.passed] goal billing.passed # extra attributes we want to log # these exist on the user log_options :passenger => [:id, :current_message] end
44. class Blast < Ellington::Route facebook = Facebook.new twitter = Twitter.new billing = Billing.new lines << facebook # entry line since its the first added lines << twitter lines << billing connect_to twitter, :if_any => [facebook.passed, facebook.failed, facebook.errored] connect_to billing, :if_all => [facebook.passed, twitter.passed] goal billing.passed # extra attributes we want to log # these exist on the user log_options :passenger => [:id, :current_message] end
45. class Blast < Ellington::Route facebook = Facebook.new twitter = Twitter.new billing = Billing.new lines << facebook # entry line since its the first added lines << twitter lines << billing connect_to twitter, :if_any => [facebook.passed, facebook.failed, facebook.errored] connect_to billing, :if_all => [facebook.passed, twitter.passed] goal billing.passed # extra attributes we want to log # these exist on the user log_options :passenger => [:id, :current_message] end
46. class Blast < Ellington::Route facebook = Facebook.new twitter = Twitter.new billing = Billing.new lines << facebook # entry line since its the first added lines << twitter lines << billing connect_to twitter, :if_any => [facebook.passed, facebook.failed, facebook.errored] connect_to billing, :if_all => [facebook.passed, twitter.passed] goal billing.passed # extra attributes we want to log # these exist on the user log_options :passenger => [:id, :current_message] end
47. class Blast < Ellington::Route facebook = Facebook.new twitter = Twitter.new billing = Billing.new lines << facebook # entry line since its the first added lines << twitter lines << billing connect_to twitter, :if_any => [facebook.passed, facebook.failed, facebook.errored] connect_to billing, :if_all => [facebook.passed, twitter.passed] goal billing.passed # extra attributes we want to log # these exist on the user log_options :passenger => [:id, :current_message] end
48. class Blast < Ellington::Route facebook = Facebook.new twitter = Twitter.new billing = Billing.new lines << facebook # entry line since its the first added lines << twitter lines << billing connect_to twitter, :if_any => [facebook.passed, facebook.failed, facebook.errored] connect_to billing, :if_all => [facebook.passed, twitter.passed] goal billing.passed # extra attributes we want to log # these exist on the user log_options :passenger => [:id, :current_message] end
49. class Blast < Ellington::Route facebook = Facebook.new twitter = Twitter.new billing = Billing.new lines << facebook # entry line since its the first added lines << twitter lines << billing connect_to twitter, :if_any => [facebook.passed, facebook.failed, facebook.errored] connect_to billing, :if_all => [facebook.passed, twitter.passed] goal billing.passed # extra attributes we want to log # these exist on the user log_options :passenger => [:id, :current_message] end
50. WHAT COMES FOR FREE
51. INTELLIGENT LOGGING [STATION COMPLETED] [PASS] [VerifyFacebookToken::Facebook::Blast] [id:1b56efc7-52bc-4ecd-a9c [STATION COMPLETED] [PASS] [CanPost::Facebook::Blast] [id:1b56efc7-52bc-4ecd-a9cc-ea86ab1d5a [STATION COMPLETED] [PASS] [ShouldPost::Facebook::Blast] [id:1b56efc7-52bc-4ecd-a9cc-ea86ab1 [STATION COMPLETED] [PASS] [Post::Facebook::Blast] [id:1b56efc7-52bc-4ecd-a9cc-ea86ab1d5ab6] [LINE COMPLETED] [PASS] [Facebook::Blast] [id:1b56efc7-52bc-4ecd-a9cc-ea86ab1d5ab6] [current [STATION COMPLETED] [PASS] [VerifyTwitterToken::Twitter::Blast] [id:1b56efc7-52bc-4ecd-a9cc- [STATION COMPLETED] [PASS] [CanTweet::Twitter::Blast] [id:1b56efc7-52bc-4ecd-a9cc-ea86ab1d5a [STATION COMPLETED] [PASS] [ShouldTweet::Twitter::Blast] [id:1b56efc7-52bc-4ecd-a9cc-ea86ab1 [STATION COMPLETED] [PASS] [Tweet::Twitter::Blast] [id:1b56efc7-52bc-4ecd-a9cc-ea86ab1d5ab6] [LINE COMPLETED] [PASS] [Twitter::Blast] [id:1b56efc7-52bc-4ecd-a9cc-ea86ab1d5ab6] [current_ [STATION COMPLETED] [PASS] [VerifyCreditCard::Billing::Blast] [id:1b56efc7-52bc-4ecd-a9cc-ea [STATION COMPLETED] [PASS] [BillCreditCard::Billing::Blast] [id:1b56efc7-52bc-4ecd-a9cc-ea86 [STATION COMPLETED] [PASS] [SendBillingNotification::Billing::Blast] [id:1b56efc7-52bc-4ecd- [LINE COMPLETED] [PASS] [Billing::Blast] [id:1b56efc7-52bc-4ecd-a9cc-ea86ab1d5ab6] [current_ [ROUTE COMPLETED] [PASS] [Blast] [id:1b56efc7-52bc-4ecd-a9cc-ea86ab1d5ab6] [current_message: [STATION COMPLETED] [PASS] [VerifyFacebookToken::Facebook::Blast] [id:28997780-a55e-48ea-ae7 [STATION COMPLETED] [PASS] [CanPost::Facebook::Blast] [id:28997780-a55e-48ea-ae74-e8549da78e [STATION COMPLETED] [PASS] [ShouldPost::Facebook::Blast] [id:28997780-a55e-48ea-ae74-e8549da [STATION COMPLETED] [PASS] [Post::Facebook::Blast] [id:28997780-a55e-48ea-ae74-e8549da78ebb] [LINE COMPLETED] [PASS] [Facebook::Blast] [id:28997780-a55e-48ea-ae74-e8549da78ebb] [current [STATION COMPLETED] [PASS] [VerifyTwitterToken::Twitter::Blast] [id:28997780-a55e-48ea-ae74- [STATION COMPLETED] [PASS] [CanTweet::Twitter::Blast] [id:28997780-a55e-48ea-ae74-e8549da78e [STATION COMPLETED] [PASS] [ShouldTweet::Twitter::Blast] [id:28997780-a55e-48ea-ae74-e8549da [STATION COMPLETED] [PASS] [Tweet::Twitter::Blast] [id:28997780-a55e-48ea-ae74-e8549da78ebb] [LINE COMPLETED] [PASS] [Twitter::Blast] [id:28997780-a55e-48ea-ae74-e8549da78ebb] [current_ [STATION COMPLETED] [PASS] [VerifyCreditCard::Billing::Blast] [id:28997780-a55e-48ea-ae74-e8 [STATION COMPLETED] [FAIL] [BillCreditCard::Billing::Blast] [id:28997780-a55e-48ea-ae74-e854 [LINE COMPLETED] [FAIL] [Billing::Blast] [id:28997780-a55e-48ea-ae74-e8549da78ebb] [current_ [ROUTE COMPLETED] [FAIL] [Blast] [id:28997780-a55e-48ea-ae74-e8549da78ebb] [current_message: [STATION COMPLETED] [PASS] [VerifyFacebookToken::Facebook::Blast] [id:862c65f8-9958-49aa-991 [STATION COMPLETED] [PASS] [CanPost::Facebook::Blast] [id:862c65f8-9958-49aa-9918-0c6a0d3237
52. [3] pry(main)> Blast.states => {"PRE Blast"=> ["PASS VerifyFacebookToken::Facebook", "FAIL VerifyFacebookToken::Facebook", "ERROR VerifyFacebookToken::Facebook"], "PASS VerifyFacebookToken::Facebook"=> ["PASS CanPost::Facebook", "FAIL CanPost::Facebook", "ERROR CanPost::Facebook", "PASS VerifyTwitterToken::Twitter", "FAIL VerifyTwitterToken::Twitter", "ERROR VerifyTwitterToken::Twitter"], "FAIL VerifyFacebookToken::Facebook"=> ["PASS VerifyTwitterToken::Twitter", "FAIL VerifyTwitterToken::Twitter", "ERROR VerifyTwitterToken::Twitter"], "ERROR VerifyFacebookToken::Facebook"=> ["PASS VerifyFacebookToken::Facebook", "FAIL VerifyFacebookToken::Facebook", "ERROR VerifyFacebookToken::Facebook", "PASS VerifyTwitterToken::Twitter", "FAIL VerifyTwitterToken::Twitter", "ERROR VerifyTwitterToken::Twitter"], STATES & TRANSITIONS
53. VISUALIZATIONS
54. BASIC LINE
55. BASIC LINE WITH PASSENGER
56. ADVANCED LINE
57. ADVANCED LINE WITH PASSENGER
58. BASIC ROUTE
59. BASIC ROUTE WITH PASSENGER
60. ADVANCED ROUTE
61. TAKE AWAYS • Encourages better design • Very light • Understandable • Modular • Composable • Testable
62. BENEFITS & USES • Demands up-front BPM • Structured query-able logs • Facilitates monitoring & analytics • Passenger visualizations support self-help administration
63. SMALL < 1000 lines of code
64. Github: hopsoft Twitter: @hopsoft Questions?