Fire - Aimee and Tram #8

trambui09 · 2020-10-09T17:07:16Z

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?	Explored it based on the instructions. Specifically, we looked at how the response was formatted through Postman/Ruby and what different parameters were needed. For the next project, we learned how to properly read through the API documentation.
Give a short summary of the request/response cycle. Where does your program fit into that scheme?	The client sends a request to the server and the server interprets the request and sends back a response. There are different types of requests, we used get and post in our project to the Slack API.
How does your program check for and handle errors when using the Slack API?	We have a custom error called SlackAPI Error that inherited from Exception. If the user encounters the error, we rescued the error to ensure that our program does not break.
How did the design and organization of your project change over time?	Our CLI control loop with the slack.rb changed wave after wave to account for the added requirements. We also discovered how template methods needed to be utilized in its child classes and be properly linked to the workspace class.
Did you use any of the inheritance idioms we've talked about in class? How?	Yes, recipient is our abstract class, it was never instantiated, but the user and channel classes inherited from the recipient and overrode the template methods of details and .list_all.
How does VCR aid in testing a program that uses an API?	VCR allows us to create cassettes (API mocking/stubbing) to record our prior requests and store the response in file. Therefore, we can run our code/tests without calling the API again (given that it's a recorded request). These recorded tests can be run offline.

…master

Update README.md for testing

CheezItMan

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.	✔️, nice work here!
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	✔️?

Overall Feedback

Overall Feedback	Criteria	yes/no
Green (Meets/Exceeds Standards)	7+ in Code Review && 3+ in Functional Requirements

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	✅

Summary

This was really excellent work. You hit all the learning goals with a great design. Take a look at my comments and let me know what questions you have. Well done.

CheezItMan · 2020-10-15T17:47:04Z

.gitignore

@@ -1,6 +1,7 @@
-/coverage/
+/old/

 .DS_Store

 # Ignore environemnt variables


Suggested change

# Ignore environemnt variables

# Ignore environment variables

CheezItMan · 2020-10-15T17:47:57Z

.gitignore

@@ -1,6 +1,7 @@
-/coverage/
+/old/


Please add coverage to your .gitignore it keeps the pull request manageable in size.

Suggested change

/old/

/old/

coverage

CheezItMan · 2020-10-15T17:48:28Z

lib/channel.rb

+    rescue SlackAPIError => exception
+      puts '🔥👾👾🔥👾🔥👾👾🔥👾🔥👾👾🔥👾👾🔥👾👾🔥👾👾🔥👾👾🔥'
+      puts "Encountered an error: #{exception}"
+      puts '🔥👾👾🔥👾🔥👾👾🔥👾🔥👾👾🔥👾👾🔥👾👾🔥👾👾🔥👾👾🔥'
+    end


CheezItMan · 2020-10-15T17:49:56Z

lib/recipient.rb

+  def self.get(url, params)
+    response = HTTParty.get(url, params)
+    unless response['ok'] == true
+      raise SlackAPIError, "API call failed - #{response['error']}"
+    end
+
+    return response
+  end


Great helper method

CheezItMan · 2020-10-15T17:50:26Z

lib/channel.rb

+    return info
+  end
+
+  def self.list_all


CheezItMan · 2020-10-15T17:50:58Z

lib/user.rb

+
+Dotenv.load
+
+class User < Recipient


👍 Nice work here!

CheezItMan · 2020-10-15T17:51:49Z

lib/workspace.rb

+  def select_user(id)
+
+    user_array = @users.find do |user|
+      user.slack_id == id || user.name == id
+    end
+    # @selected is an instance of the chosen user
+    @selected = user_array
+
+    puts "user #{id} not found" if @selected.nil?
+
+    return @selected
+
+  end


Just notice how select_user and select_channel are pretty much the same, just use a different array?

Maybe make a helper method that takes the list of recipients to search through as a parameter.

CheezItMan · 2020-10-15T17:53:09Z

test/recipient_test.rb

+    end
+  end
+
+  describe "send_message" do


Nice tests!

trambui09 and others added 30 commits October 5, 2020 21:04

wave 0 completed, wrote workspace.rb

8136f54

added to the slack.rb

1967184

created channel.rb class

1c86e02

created the recipient parent class

5d32730

created user class

34cbfeb

created the test files and wrote test in the recipient_test

6101c50

added details to the slack file

8d63f14

worked on control flow and created instance of workspace and tp

64c4365

worked on the .list_all method

7dabea5

make changes to minor methods

5eeeca7

wave 1 tests

41bce3e

refactored channel, recipient, and user classes

700f0be

updated wave 1 tests and refactored code

196ec7b

made changes to slack.rb and test_helper.rb

a6f0a6f

Merge branch 'master' of https://github.com/trambui09/slack-cli into …

c05e530

…master

minor refactor

30c4f78

Working on Wave 2 - select methods not working yet

c8a818c

Merge branch 'master' of https://github.com/trambui09/slack-cli into …

c1a5dc8

…master

#select_user method working, need to verify if return value is correct

1f0a377

worked on the select user method

687e40b

merging and adding workspace_test

4f2368f

wrote most tests and code for selected_channel

6de2059

add coverage directory to .gitignore file

5a040eb

made minor changes to workspace

33ca33c

worked more on wave 2 tests

c5fbb85

added tests for wave 2

cc340fd

wave 3

ca9331f

wave 3 - working on recipient test

8f8e28c

fixed api error test for recipient

7ec809d

wrote more tests for recipient_test.rb

32d295f

marks214 and others added 11 commits October 8, 2020 21:23

finished tests for wave 3, refactored

b612475

added tests to user and channel

b80b25e

added more tests to user and channel

ea7a775

added tests for channel

60eb469

added more tests to user and channel

88f6d8d

added tests to recipient

15b95b0

deleted superflous comments

38c116e

tests for recipient

d6d2fe3

more tests for user and channel

cfc14c9

Update README.md

33267c7

Merge pull request #1 from trambui09/test

f4b5979

Update README.md for testing

CheezItMan reviewed Oct 15, 2020

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fire - Aimee and Tram #8

Fire - Aimee and Tram #8

trambui09 commented Oct 9, 2020 •

edited

Loading

CheezItMan left a comment

CheezItMan Oct 15, 2020

CheezItMan Oct 15, 2020

CheezItMan Oct 15, 2020

CheezItMan Oct 15, 2020

CheezItMan Oct 15, 2020

CheezItMan Oct 15, 2020

CheezItMan Oct 15, 2020

CheezItMan Oct 15, 2020

	# Ignore environemnt variables
	# Ignore environment variables

Fire - Aimee and Tram #8

Are you sure you want to change the base?

Fire - Aimee and Tram #8

Conversation

trambui09 commented Oct 9, 2020 • edited Loading

Assignment Submission: Slack CLI

Reflection

CheezItMan left a comment

Choose a reason for hiding this comment

Slack CLI

Major Learning Goals/Code Review

Functional Requirements

Overall Feedback

Code Style Bonus Awards

Summary

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trambui09 commented Oct 9, 2020 •

edited

Loading