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

Water @ Beatrice and Hanh Solo Slack-cli submission #14

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

Conversation

seattlefurby17
Copy link

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? Read the documentations and tried it out in postman. The lessons were helpful. VCR, postman, httparty ...all the gems were in used in this project.
Give a short summary of the request/response cycle. Where does your program fit into that scheme? As soon as slack.rb ran, an API request was send for the numbers of users and channels. After that a user made a request and our program sent the request to the API - cassettes to get a response and sent it back the user.
How does your program check for and handle errors when using the Slack API? We checked the program respond returned a 200 code and 'ok' = true. We raised SlackApiError otherwise.
How did the design and organization of your project change over time? We did not made any big change because we followed the suggested diagram closely from the start.
Did you use any of the inheritance idioms we've talked about in class? How? Yes, we did. As mentioned, we used the suggested diagram to build a super class, Recipient and two subclasses, User and Channel. We also employed template method and polymorphism.
How does VCR aid in testing a program that uses an API? VCR allowed us to not have to call the API every time we ran/tested the program.

Copy link

@dHelmgren dHelmgren left a comment

Choose a reason for hiding this comment

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

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 found the one crash by accident. :'(

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

lib/slack.rb Outdated
begin
success = workspace.selected.send_message(message)
rescue SlackApiError => exception
put "Messages can not be send, #{exception.message}"

Choose a reason for hiding this comment

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

oops. Gotta run that error code by hand here. Your put instead of puts causes a crash!

lib/workspace.rb Outdated
@@ -0,0 +1,60 @@
# frozen_string_literal: true

require_relative 'recipient'

Choose a reason for hiding this comment

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

You actually don't need to require recipient here because you required it in channel and user ;)

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