Merge pull request #6 from /issues/4-use-cases

Adding text response use case diagrams diagrams

.github/workflows/plantuml.yml

@@ -0,0 +1,18 @@
+name: embed plantuml
+on: push
+jobs:
+  embed-puml-markdown:
+    runs-on: ubuntu-latest
+    name: plantuml
+    steps:
+    - name: Check out the repo
+      uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - name: Embed PlantUML inside Markdown
+      uses: alessandro-marcantoni/puml-markdown@v0.1.1
+    - name: Push Local Changes
+      uses: stefanzweifel/git-auto-commit-action@v4.1.2
+      with:
+        commit_message: "Generate PlantUML diagrams"
+        branch: ${{ github.head_ref }}

docs/README.md

@@ -1,3 +1,5 @@
 # Documentation
 
-[State Diagram & Documentation](./states.md)
+[State Diagram](./state-diagram.md)
+
+[Use Cases](./use-cases.md)

docs/diagrams/case-found-no-reminder-set.puml

@@ -0,0 +1,8 @@
+@startuml
+skinparam sequenceMessageAlign center
+
+User -> Server: 01-AB-23456
+Server -> User: We found case "01-AB-23456" on 7/28/2022 1:00 PM @ Family/Criminal Courtroom 2A Chittenden, VT.\nReply with YES if you would like a courtesy reminder the day before or reply with NO to start over.
+User -> Server: No
+Server -> User: You said no so we won't text you a reminder. You can always go to https://www.vermontjudiciary.org/court-hearings for more information about your case.
+@enduml

docs/diagrams/case-found-sign-up-for-reminder.puml

@@ -0,0 +1,8 @@
+@startuml
+skinparam sequenceMessageAlign center
+
+User -> Server: 01-AB-23456
+Server -> User: We found case "01-AB-23456" on 7/28/2022 1:00 PM @ Family/Criminal Courtroom 2A Chittenden, VT.\nReply with YES if you would like a courtesy reminder the day before or reply with NO to start over.
+User -> Server: Yes
+Server -> User: Reminder set for case (01-AB-23456)
+@enduml

docs/diagrams/case-not-found.puml

@@ -0,0 +1,6 @@
+@startuml
+skinparam sequenceMessageAlign center
+
+User -> Server: 01-NOT-FOUND
+Server -> User: We did not find any cases that match 01-NOT-FOUND
+@enduml

docs/diagrams/multiple-cases-no-reminder-set.puml

@@ -0,0 +1,8 @@
+@startuml
+skinparam sequenceMessageAlign center
+
+User -> Server: 01-AB-23456
+Server -> User: We found 3 cases.\nReply with a # if you would like a courtesy reminder the day before or reply with NO to start over.\n1 - "01-AB-23456" on 7/28/2022 1:00 PM @ Family/Criminal Courtroom 2A Chittenden, VT.\n2 - "01-AB-23456" on 8/1/2022 1:00 PM @ Family/Criminal Courtroom 2A Chittenden, VT.\n3 - "01-AB-23456" on 8/5/2022 1:00 PM @ Family/Criminal Courtroom 2A Chittenden, VT.
+User -> Server: No
+Server -> User: You said no so we won't text you a reminder. You can always go to https://www.vermontjudiciary.org/court-hearings for more information about your case.
+@enduml

docs/diagrams/multiple-cases.puml

@@ -0,0 +1,8 @@
+@startuml
+skinparam sequenceMessageAlign center
+
+User -> Server: 01-AB-23456
+Server -> User: We found 3 cases.\nReply with a # if you would like a courtesy reminder the day before or reply with NO to start over.\n1 - "01-AB-23456" on 7/28/2022 1:00 PM @ Family/Criminal Courtroom 2A Chittenden, VT.\n2 - "01-AB-23456" on 8/1/2022 1:00 PM @ Family/Criminal Courtroom 2A Chittenden, VT.\n3 - "01-AB-23456" on 8/5/2022 1:00 PM @ Family/Criminal Courtroom 2A Chittenden, VT.
+User -> Server: 2
+Server -> User: Reminder set for case (01-AB-23456)
+@enduml

docs/diagrams/regex-not-matched.puml

@@ -0,0 +1,6 @@
+@startuml
+skinparam sequenceMessageAlign center
+
+User -> Server: not a valid input
+Server -> User: Reply with a docket number to sign up for a reminder. Docket numbers look like 3 sets of numbers or characters. For example: 123-45-67 or 123-CR-45.
+@enduml

docs/state-diagram.md

@@ -0,0 +1,5 @@
+# API States
+
+## State Diagram
+
+[![State Diagram](https://tinyurl.com/2nfyuxmj)](https://tinyurl.com/2nfyuxmj)<!--![State Diagram](./diagrams/state-diagram.puml)-->

docs/use-cases.md

@@ -0,0 +1,25 @@
+# Use Cases
+
+## User successfully finds a case and signs up for a reminder
+
+[![User successfully finds a case and signs up for a reminder](https://tinyurl.com/2frde86r)](https://tinyurl.com/2frde86r)<!--![User successfully finds a case and signs up for a reminder](./diagrams/case-found-sign-up-for-reminder.puml)-->
+
+## User doesn't find a case
+
+[![User doesn't find a case](https://tinyurl.com/2llf9cvy)](https://tinyurl.com/2llf9cvy)<!--![User doesn't find a case](./diagrams/case-not-found.puml)-->
+
+## User enters an input that doesn't match regex
+
+[![User enters an input that doesn't match regex](https://tinyurl.com/2ql2o2s7)](https://tinyurl.com/2ql2o2s7)<!--![User enters an input that doesn't match regex](./diagrams/regex-not-matched.puml)-->
+
+## User finds a case but doesn't sign up for notification
+
+[![User finds a case but doesn't sign up for notification](https://tinyurl.com/2e5hkbzp)](https://tinyurl.com/2e5hkbzp)<!--![User finds a case but doesn't sign up for notification](./diagrams/case-found-no-reminder-set.puml)-->
+
+## User finds multiple cases
+
+[![User finds multiple cases](https://tinyurl.com/2nab39j3)](https://tinyurl.com/2nab39j3)<!--![User finds multiple cases](./diagrams/multiple-cases.puml)-->
+
+## User finds multiple cases but replies no
+
+[![User finds multiple cases but replies no](https://tinyurl.com/2r24h7rq)](https://tinyurl.com/2r24h7rq)<!--![User finds multiple cases but replies no](./diagrams/multiple-cases-no-reminder-set.puml)-->