Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Earth - Beauttie - Olga #13

Open
wants to merge 25 commits into
base: master
Choose a base branch
from
Open

Earth - Beauttie - Olga #13

wants to merge 25 commits into from

Conversation

OlgaSe
Copy link

@OlgaSe OlgaSe commented Oct 9, 2020

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? We learnt get and post requests and what they're requiring for proper usage. The most information about their functionality were in the documentation, that helped a lot. For next projects main take away is reading API documentation first, because all of them are different.
Give a short summary of the request/response cycle. Where does your program fit into that scheme? The client send request to the server (API) via application and server receives the request, process it and sends a response, the client receives the response and readable. Then starting the cycle all over again. In our program Recipient as a client sent request to the Slack API (Server), received the response and checked it for errors.
How does your program check for and handle errors when using the Slack API? Our program checks the response code and displays error message if the call fails.
How did the design and organization of your project change over time? We spent some time on understanding of provided instructor's design schema, so our project's organization didn't change too much.
Did you use any of the inheritance idioms we've talked about in class? How? Yes, Recipient is an abstract class with template methods: details and list_all. Our workspace allows polymorphism to occur when printing output for user and channel classes.
How does VCR aid in testing a program that uses an API? It records our calls to API and save our responses for play back, so we don't have to make real requests while testing.

@jmaddox19
Copy link

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 ✔️ Yes! So many good commits with descriptive messages from both of you!

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

Great work!! Y'all made a whole program that interacts with Slack in real time from the command terminal!!
I hope y'all have gotten to celebrate and appreciate how fun of an accomplishment that is!!
The program all works together as expected and the code is very readable!

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants