Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions feedback.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Feedback Rubric

- Student Being Reviewed:
- Reviewer:
- Classroom:
- Student Being Reviewed: Yaz O'Shaughnessy
- Reviewer: Jocelyn Wang
- Classroom: Time

## Manual App Testing

Expand All @@ -17,7 +17,7 @@
1. 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.)
</td>
<td>
yes/no
yes
</td>
</tr>

Expand All @@ -26,7 +26,7 @@
2. 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.)
</td>
<td>
yes/no
yes
</td>
</tr>

Expand All @@ -35,7 +35,7 @@
3. 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.
</td>
<td>
yes/no
yes
</td>
</tr>

Expand All @@ -51,7 +51,7 @@
</ul>
</td>
<td>
yes/no
yes
</td>
</tr>

Expand All @@ -60,7 +60,7 @@
5. Practices instance methods vs. class methods appropriately. (The methods to list all Channels or Users is a class method within those respective classes.)
</td>
<td>
yes/no
yes
</td>
</tr>

Expand All @@ -70,7 +70,7 @@
6. Practices best practices for testing. (The project has and uses VCR mocking when running tests, and can run offline.)
</td>
<td>
yes/no
yes
</td>
</tr>

Expand All @@ -80,7 +80,7 @@
7. Practices writing tests. (The User, Channel, and Workspace classes have unit tests.)
</td>
<td>
yes/no
yes
</td>
</tr>

Expand All @@ -90,7 +90,7 @@
8. There are also tests for sending messages (the location of these tests may differ, but is likely in Recipient)
</td>
<td>
yes/no
yes
</td>
</tr>

Expand All @@ -100,7 +100,7 @@
9. Practices git with at least 15 small commits and meaningful commit messages
</td>
<td>
yes/no
yes
</td>
</tr>
</table>
Expand All @@ -118,31 +118,31 @@
<td>1. As a user of the CLI program, I can <strong>list</strong> users and channels with the commands <code>list users</code> and <code>list channels</code>
</td>
<td>
yes/no
yes
</td>

</tr>
<tr>
<td>2. As a user of the CLI program, I can <strong>select</strong> users and channels with the commands <code>select user</code> and <code>select channel</code>
</td>
<td>
yes/no
yes
</td>
</tr>

<tr>
<td>3. As a user of the CLI program, I can show the details of a selected user or channel with the command <code>details</code>
</td>
<td>
yes/no
yes
</td>
</tr>

<tr>
<td>4. As a user of the CLI program, when I input something inappropriately, the program runs without crashing. Example commands to try are <code>do_something</code>, or <code>select user</code> followed by <code>Mr. Fakename</code>
</td>
<td>
yes/no
yes
</td>
</tr>
</table>
Expand Down
49 changes: 31 additions & 18 deletions individual-reflection.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,48 +9,61 @@ Answer the following comprehension questions **within this file.** Write your an
### `GET` Request Review

1. Describe a GET request that your project makes, and the high-level description of what it does
- Answer:
- Answer: In Reciepient.make_query, a get request is constructed and made based on the kind of recipient it is passsed. The get request is for the details of a specific channel or user.
1. What is the verb of this request?
- Answer:
- Answer: Get
1. What is the path (or the URL, or endpoint) of this request?
- Answer:
- Answer: the endpoint depends on whether "channel" or "user" is passed into the method. Here's the line of code that conditionally constructs the url: BASE_URL + "#{recipient_kind}s.list". Where BASE_URL = 'https://slack.com/api/'.
1. What are the query params (the additional data sent with the request, besides the verb and the path)?
- Answer:
- Answer: The only query parameter I use for the GET request is my API Token.

1. What is the syntax used to make this request? (Copy and paste a code snippet here)
- Answer:
```ruby
# Copy and paste your answer below this comment

# In helper file:
QUERY_PARAM = {
token: API_KEY
}
# In recipient.rb
response = HTTParty.get(BASE_URL + "#{recipient_kind}s.list", query: QUERY_PARAM)
# Copy and paste your answer above this comment
```
1. What does the program do if the response comes back with a status code of 200?
- Answer:
- Answer: The method calling the GET request returns the valid response. This class method is called in Channel and User's class method get_list, which then iterates through the response as a means for factory construction.
1. What does the program do if the response does not come back with a status code of 200?
- Answer:
- Answer: It throws a custom error called API_Error and prints the error message included in the response.

### `POST` Request Review

If your project does not make a POST request, read through Wave 3 on the original Slack CLI, and research and answer questions 1, 2, 3, 4, 6, and 7.

1. Describe a POST request that your project makes, and the high-level description of what it does
- Answer:
- Answer: In workspace instance method post, a POST request is made to write a message either to a channel or in a direct message to a user.
1. What is the verb of this request?
- Answer:
- Answer: POST
1. What is the path (or the URL, or endpoint) of this request?
- Answer:
- Answer: 'https://slack.com/api/chat.postMessage'
1. What are the query params (the additional data sent with the request, besides the verb and the path)?
- Answer:
- Answer: THe API token, the slack id of the destination user or channel, and the text of the message.
1. What is the syntax used to make this request? (Copy and paste a code snippet here)
- Answer:
```ruby
# Copy and paste your answer below this comment

# from instance method post:
response = HTTParty.post(BASE_URL + 'chat.postMessage', body: compose_message(text, destination))
# from private instance method compose_method:
return post_param = {
token: API_KEY,
channel: destination.slack_id,
text: text
}
# Copy and paste your answer above this comment
```
1. What does the program do if the response comes back with a status code of 200?
- Answer:
- Answer: It records the message to the recipients message history field and returns the response to what ever part of the program made the workspace#post method call. In this case, to slack.rb.
1. What does the program do if the response does not come back with a status code of 200?
- Answer:
- Answer: It throws a custom error called API_Error and prints the error message included in the response.

## Request & Response Cycle

Expand All @@ -62,11 +75,11 @@ There are two actors:

Based on the project requirements, when Grace enters "list channels,"
1. What is the request being made in the program?
- Answer:
- Answer: When the user ran slack.rb, a workspace was constructer, which factory constructed lists of channels and users - both of which were made by sending a GET request to the Slack API
1. Who is the client?
- Answer:
- Answer: The user, Grace.
1. Who is the server?
- Answer:
- Answer: Slack API

## Part 2: Optional Refactoring

Expand All @@ -80,4 +93,4 @@ If your reflection inspired you to make minimal changes to your Slack CLI implem

### Describe your optional Slack CLI changes here

Answer:
Answer: none.