Rachael and Christabel Slack-CLI #3
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…l_test.rb as "self.list_all"
…ide of VCR control blocks
…loops during testing.
…or select_channel and select_user.
…e selections. As well as validation.
…age method is not passing its test
…nt. added a count of members and channels at the beginning of the interface
…output response["error"]
There was a problem hiding this comment.
Slack CLI
Major Learning Goals/Code Review
| Criteria | yes/no, and optionally any details/lines of code to reference |
|---|---|
Practices best practices working with APIs. The .env is not checked into git, and no API token was directly used in the Ruby code without ENV. |
✔️ |
| Practices error handling with APIs. For all pieces of code that make an API call, it handles API requests that come back with errors/error status codes appropriately. | ✔️ |
Implements inheritance and inheritance idioms. There is a Recipient class. User and Channel inherit from Recipient. In Recipient, there are appropriate methods defined that are used in both User and Channel. Some may be implemented. Some may be template methods. |
✔️ |
Practices clean code. lib/slack.rb only interacts with Workspace to show a separation of responsibilities. Complex logic is broken into smaller helper methods. |
✔️ |
| Practices instance methods vs. class methods appropriately. The methods to list all Channels or Users is likely a class method within those respective classes. | ✔️ |
| Practices best practices for testing. The project has and uses VCR mocking when running tests, and can run offline. | ✔️ |
Practices writing tests. The User, Channel, and Workspace classes have unit tests. |
✔️ |
Practices writing tests. There are tests for sending messages (the location of these tests may differ, but is likely in Recipient) |
✔️ |
| Practices git with at least 15 small commits and meaningful commit messages | ✔️ |
Functional Requirements
| Functional Requirement | yes/no |
|---|---|
| As a user of the CLI program, I can list users and channels | ✔️ |
| As a user of the CLI program, I can select users and channels | ✔️ |
| As a user of the CLI program, I can show the details of a selected user or channel | ✔️ |
| As a user of the CLI program, when I input something inappropriately, the program runs without crashing | ✔️ |
Overall Feedback
Excellent work overall. This code is well-written and well-tested. It is clear to me that the learning goals around understanding the request/response cycle, consuming an API, and implementing a design using inheritance from scratch were all met. I've left a few inline comments for you to review, including ways you could consider refactoring. Keep up the hard work!
| Overall Feedback | Criteria | yes/no |
|---|---|---|
| Green (Meets/Exceeds Standards) | 7+ in Code Review && 3+ in Functional Requirements | ✔️ |
| Yellow (Approaches Standards) | 6+ in Code Review && 2+ in Functional Requirements | |
| Red (Not at Standard) | 0-5 in Code Review or 0,1 in Functional Reqs, or assignment is breaking/doesn’t run with less than 5 minutes of debugging |
Code Style Bonus Awards
Was the code particularly impressive in code style for any of these reasons (or more...?)
| Quality | Yes? |
|---|---|
| Perfect Indentation | ✅ |
| Elegant/Clever | ✅ |
| Concise | ✅ |
| Logical/Organized | ✅ |
Comment on lines
+31
to
+37
| def self.error_message(response) | ||
| if response["ok"] != true | ||
| raise ArgumentError, "API request failed with error: #{response["error"]}." | ||
| else | ||
| return response | ||
| end | ||
| end |
|
|
||
| def send_message(message) | ||
| params = {token: ENV['SLACK_TOKEN'], channel: @slack_id, text: message} | ||
| return self.class.error_message(HTTParty.post(POST_URL, body: params)) |
There was a problem hiding this comment.
This is a lot in one line. Consider making the post request, storing the response in a variable likeresponse and then calling the helper method error_message to increase readability.
Comment on lines
+35
to
+50
| if selected_recipient | ||
| puts "Would you like details? (yes/no)" | ||
| details_selection = input_validation(gets.chomp.downcase) | ||
| if details_selection == "yes" | ||
| puts workspace.show_details(selected_recipient) | ||
| end | ||
| puts "Would you like to #{selected_recipient.class == User ? "send a message" : "post"} to #{selected_recipient.name}? (yes/no)" | ||
| message_selection = input_validation(gets.chomp.downcase) | ||
| if message_selection == "yes" | ||
| puts "Please write your message." | ||
| message = gets.chomp | ||
| selected_recipient.send_message(message) | ||
| end | ||
| else | ||
| puts "No #{(selection == 3) ? "user" : "channel"} found." | ||
| end |
There was a problem hiding this comment.
Nice choice to only prompt the user for details of sending message if a user has been selected. Consider breaking the functionality to show details and send message into helper methods.
| return input | ||
| end | ||
|
|
||
| def translate_input(string_input) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Assignment Submission: Slack CLI
Congratulations! You're submitting your assignment. Please reflect on the assignment with these questions.
Reflection