Fire - Jing & Ren #2

Jing-321 · 2020-10-08T19:17:02Z

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?	Reading API document is very crucial to understand how to use a particular API.
Give a short summary of the request/response cycle. Where does your program fit into that scheme?	We send request as client to Slack API, and received response from Slack API. We use this process to look at users and channels and to send messages.
How does your program check for and handle errors when using the Slack API?	We check the response["ok"] to make sure it is true. We also rescued one of the exceptions in slack.rb.
How did the design and organization of your project change over time?	At first we just have our method in the driver code(slack.rb). Later, we added abstract class (Recipient), and child classes (User and Channel) to hold the methods. And then call them in the driver code.
Did you use any of the inheritance idioms we've talked about in class? How?	abstract class, templet classs, Polymorphism
How does VCR aid in testing a program that uses an API?	We use VCR for each test that interact Slack API. Therefore, it won't post a new message each time when we run the test.

… write a message then use http post to send message, wrote tests

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.	✔️
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

Really nice work, you hit the learning goals here. Well done. Take a look at my comments and let me know what questions you have.

CheezItMan · 2020-10-15T19:19:42Z

lib/channel.rb

+  end
+
+  def self.list_all
+    response = self.get("https://slack.com/api/conversations.list")


Nice use of a helper method in the parent class.

CheezItMan · 2020-10-15T19:19:47Z

lib/channel.rb

@@ -0,0 +1,23 @@
+require_relative 'recipient'
+
+class Channel < Recipient


CheezItMan · 2020-10-15T19:20:02Z

lib/recipient.rb

+  def self.get(url)
+    return HTTParty.get(url, query: {token: SLACK_TOKEN})
+  end


CheezItMan · 2020-10-15T19:21:34Z

lib/user.rb

@@ -0,0 +1,23 @@
+require_relative 'recipient'
+
+class User < Recipient


CheezItMan · 2020-10-15T19:25:16Z

test/recipient_test.rb

+  end
+end
+
+describe "send_message" do


You should also have tests for get or make that class method private.

CheezItMan · 2020-10-15T19:25:44Z

test/workspace_test.rb

+  end
+end
+
+describe "send_message" do


Good set of tests!

Jing-321 and others added 16 commits October 6, 2020 14:42

add Workspace class, add user_list & channel_list method in slack.rb

cae9773

complete print user list and channel list

0c8ba33

complete wave1: list users & channels

efd0d88

add tests for Workspace

a530980

add test for User class. pass all the tests

12d17ce

add test for Channel class. pass all the tests

cfbfe8a

add test for list_all for User and Channel

3680318

add VCR to tests

31009c8

start Workspace, did not pass tests

84a2b1b

initialize workspace. pass tests

08dc9d1

complete select and detail method. pass all the tests

87d3f06

wrote methods in slack.rb, workspace and recipient that allow user to…

2928c71

… write a message then use http post to send message, wrote tests

added tests for recipient, pass all the tests

f003578

tweaked slack.rb to output a message in the case of exceptions

36959ae

added more distinctive menu

c6a8fd1

just adding silly emjois now apparently haha

286d659

CheezItMan reviewed Oct 15, 2020

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fire - Jing & Ren #2

Fire - Jing & Ren #2

Jing-321 commented Oct 8, 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

		@@ -0,0 +1,23 @@
		require_relative 'recipient'

		class Channel < Recipient

		@@ -0,0 +1,23 @@
		require_relative 'recipient'

		class User < Recipient

Fire - Jing & Ren #2

Are you sure you want to change the base?

Fire - Jing & Ren #2

Conversation

Jing-321 commented Oct 8, 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

CheezItMan Oct 15, 2020

Choose a reason for hiding this comment

CheezItMan Oct 15, 2020

Choose a reason for hiding this comment

CheezItMan Oct 15, 2020

Choose a reason for hiding this comment

CheezItMan Oct 15, 2020

Choose a reason for hiding this comment

CheezItMan Oct 15, 2020

Choose a reason for hiding this comment

CheezItMan Oct 15, 2020

Choose a reason for hiding this comment

Jing-321 commented Oct 8, 2020 •

edited

Loading