diff --git a/feedback.md b/feedback.md index f90b999..aa33649 100644 --- a/feedback.md +++ b/feedback.md @@ -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.) - yes/no + yes @@ -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.) - yes/no + yes @@ -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. - yes/no + yes @@ -51,7 +51,7 @@ - yes/no + yes @@ -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.) - yes/no + yes @@ -70,7 +70,7 @@ 6. Practices best practices for testing. (The project has and uses VCR mocking when running tests, and can run offline.) - yes/no + yes @@ -80,7 +80,7 @@ 7. Practices writing tests. (The User, Channel, and Workspace classes have unit tests.) - yes/no + yes @@ -90,7 +90,7 @@ 8. There are also tests for sending messages (the location of these tests may differ, but is likely in Recipient) - yes/no + yes @@ -100,7 +100,7 @@ 9. Practices git with at least 15 small commits and meaningful commit messages - yes/no + no - there were 4 commits @@ -118,7 +118,7 @@ 1. As a user of the CLI program, I can list users and channels with the commands list users and list channels - yes/no + yes @@ -126,7 +126,7 @@ 2. As a user of the CLI program, I can select users and channels with the commands select user and select channel - yes/no + yes @@ -134,7 +134,7 @@ 3. As a user of the CLI program, I can show the details of a selected user or channel with the command details - yes/no + yes @@ -142,7 +142,7 @@ 4. As a user of the CLI program, when I input something inappropriately, the program runs without crashing. Example commands to try are do_something, or select user followed by Mr. Fakename - yes/no + yes and no - invalid inputs are dealth with by ending the program because an argument error is thrown diff --git a/individual-reflection.md b/individual-reflection.md index 603cdeb..68efbe6 100644 --- a/individual-reflection.md +++ b/individual-reflection.md @@ -9,48 +9,48 @@ 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: One GET request that my project makes is the request to get a list of all users in the given workspace. This request asks the API to provide all user information for every user. 1. What is the verb of this request? - - Answer: + - Answer: the verb of this request is "users.list". 1. What is the path (or the URL, or endpoint) of this request? - - Answer: + - Answer: 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 other required information is the token. 1. What is the syntax used to make this request? (Copy and paste a code snippet here) - - Answer: + - Answer: Using HTTParty, the syntax for this request is as follows: ```ruby # Copy and paste your answer below this comment - + list_results = HTTParty.get(BASE_URL + "users.list", query: {token: KEY}) # 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 program returns a formatted list of users in the workspace. 1. What does the program do if the response does not come back with a status code of 200? - - Answer: + - Answer: I did not implement a fail-safe for this case. ### `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: A POST request that my program makes is when the user chooses to send a message to another user via direct message or to a channel in the workspace. 1. What is the verb of this request? - - Answer: + - Answer: chat.postMessage 1. What is the path (or the URL, or endpoint) of this request? - - Answer: + - Answer: 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 additional data sent with this request is the token, channel/conversation id, and the message. 1. What is the syntax used to make this request? (Copy and paste a code snippet here) - - Answer: + - Answer: ```ruby # Copy and paste your answer below this comment - + HTTParty.post(BASE_URL + "chat.postMessage", query: {token: KEY, channel: @id, text: message}) # 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 program does not return anything, the message is just sent. 1. What does the program do if the response does not come back with a status code of 200? - - Answer: + - Answer: I did not implement a fail-safe for this case. ## Request & Response Cycle @@ -62,11 +62,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: The request being made in the program is channels.list 1. Who is the client? - - Answer: + - Answer: The client is the user, Grace. 1. Who is the server? - - Answer: + - Answer: The server is the Slack API. ## Part 2: Optional Refactoring @@ -81,3 +81,4 @@ If your reflection inspired you to make minimal changes to your Slack CLI implem ### Describe your optional Slack CLI changes here Answer: +I did not implement any changes, but if I were to do so I realize now that I really should have provided the user some indication of whether or not their POST request was successful or not.