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 - Genevieve and Schanen #16

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

Conversation

schanenR
Copy link

@schanenR schanenR 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 both individually played around with postman to engage the three Slack API's used in this project.
Give a short summary of the request/response cycle. Where does your program fit into that scheme? Our program represents the client making a request to the Slack API server and managing the server response.
How does your program check for and handle errors when using the Slack API? At various points where our code reacts to the API we wrote custom exceptions to manage unusual on non-functioning results.
How did the design and organization of your project change over time? The structural design was consistent form the beginning and the original interpretation was evident in the final product. The organization evolved throughout the project as complexity was built.
Did you use any of the inheritance idioms we've talked about in class? How? We did make use of template methods and polymorphism.
How does VCR aid in testing a program that uses an API? It records an API response for repeated use in testing without making repeated calls to the API. It also stores multiple API called for different tests.

@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. ✔️ Yes, almost completely. There's one awkward thing in the Builder class. (see inline comments)
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) ✔️ Great!
Practices git with at least 15 small commits and meaningful commit messages ✔️ Yes! With clear commit messages! And from both of you :D

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

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

Additional 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!

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

return response
end

def self.details

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an instance method in the child classes so the abstract method here should be an instance method as well.

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