Water - Kayla and Mackenzie

[mvlofthus]

Assignment Submission: Slack CLI

Congratulations! You're submitting your assignment. Please reflect on the assignment with these questions.

Reflection

Question	Answer
How did you go about exploring the Slack API? Did you learn anything that would be useful for your next project involving an API?	Postman was helpful for outlining what the parameters were called so we could pull the information we wanted (this will be helpful for future projects). We looked at some Slack API documentation as well, which gave us information about permissions and bots' needs.
Give a short summary of the request/response cycle. Where does your program fit into that scheme?	Client sends a request to the API, the API responds to the client. Our programs is the client requesting information from and posting information to the Slack API.
How does your program check for and handle errors when using the Slack API?	We raise argument errors when the response code or parsed message is not equal to 200 or is false. This ends the program when it cannot pull the information from the SlackAPI.
How did the design and organization of your project change over time?	We ended up with more template methods in our parent class than we originally had. At first we were thinking our program structure, especially surrounding our selected_user, would rely more heavily on child classes, and ended up using the constructor class (workspace) more. We also found it was simpler (and possibly more space and time efficient) to have our slack.rb file address nil values for selected_user immediately and repeat the prompt to the user.
Did you use any of the inheritance idioms we've talked about in class? How?	The recipient class was the template for the channel and user classes. We used polymorphism for the .list and details methods. We used template methods for .send message and .get.
How does VCR aid in testing a program that uses an API?	It records the API response and stores that data, so we don't have to send a new API request each time we run our tests. This makes this process more efficient and prevents stack overflow, it also allows us to run these tests offline.

[beccaelenzil]

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.	✔️ See in-line comment for suggestions how to break out methods further.
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.	Some of the tests have errors or fail because the cassettes were checked in, and thus my test data is different.
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 job overall. This code is well-written and well-tested. It is clear 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 below. 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	✅
Descriptive/Readable	✅
Concise	✅
Logical/Organized	✅

[beccaelenzil]

Consider wrapping this functionality into its own method.

[beccaelenzil]

Consider wrapping this set-up functionality into its own method.

[beccaelenzil]

Consider making send_msg an instance method that's called on an instance of a User or Channel. In this way, id does not need to be an argument.

[beccaelenzil]

Good work error handling.

[beccaelenzil]

Nice work error handling with a custom exception.