India and Richelle - Water #12

indiakato · 2020-10-09T18:15:32Z

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?	We used postman to help us explore working with APIs. We learned how to read API documentation, how to set up permissions, and how to save tokens safely without uploading to github.
Give a short summary of the request/response cycle. Where does your program fit into that scheme?	The command line interface sends a request to the slack API. Slack API server returns a list of channels/users in the C14 workspace. If the request or url is invalid, the api will return an error code and message and the cli will display the error.
How does your program check for and handle errors when using the Slack API?	Our cli main file checks for user input, and will loop when there is valid input. We check the validity of the API request in the recipient class, where we have the URLs hard coded. If the url is invalid, it will raise a SlackApiError, which we tested in our user_test.rb file.
How did the design and organization of your project change over time?	We originally called the APIs separately in different classes, but eventually refactored to where the code for the API call is only in the superclass. The main file changed a lot so that we are only referencing the constructor class (workspace.rb).
Did you use any of the inheritance idioms we've talked about in class? How?	Yes, we used inheritance and we have an abstract class and abstract/template methods. We used polymorphism for our .list_all and .detail template methods. We were able to call the same method on separate objects and have those methods act differently based on which object it is acting on.
How does VCR aid in testing a program that uses an API?	VCR allows us to store the data from an API call, so that every time you run the tests, you don't have to keep calling the API and prevent getting locked out from the API.

…s throughout

…options in driver code

…el attributes

…r and channel

…l method

…o run added options

…space & updated select channel & user accordingly

…er code

…or Channel topic

…g working.

… send message to users

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.	✔️, however User and Channel are pretty skimpy.
Practices writing tests. There are tests for sending messages (the location of these tests may differ, but is likely in `Recipient`)	✔️, no tests for invalid or unselected channels/users.
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

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:06:23Z

.gitignore

@@ -4,3 +4,4 @@

 # Ignore environemnt variables
 .env
+.idea/


Thank you! However also please add coverage, it makes for a smaller PR.

Suggested change

.idea/

.idea/

coverage

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

lib/channel.rb

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


Good helper method

CheezItMan · 2020-10-15T19:07:22Z

lib/recipient.rb

@@ -0,0 +1,45 @@
+class SlackApiError < StandardError; end
+
+class Recipient


Great abstract class! 😍

CheezItMan · 2020-10-15T19:08:08Z

lib/workspace.rb

+  def select_user(input)
+    @selected = @users.find { |user| user.name == input }
+    if @selected
+      return @selected
+    else
+      @selected = @users.find { |user| user.slack_id == input }
+    end
+    return @selected
+  end


Notice that select user and channel do the same thing, just to different arrays, can you make a helper method?

CheezItMan · 2020-10-15T19:08:32Z

test/channel_test.rb

@@ -0,0 +1,17 @@
+require_relative 'test_helper'
+
+describe "Channel class" do


You should also have tests for the attr_reader attributes for channels, and the constructor.

CheezItMan · 2020-10-15T19:09:55Z

test/user_test.rb

@@ -0,0 +1,26 @@
+require_relative 'test_helper'
+
+describe "User class" do


You should also have tests for the constructor/attr_reader methods.

CheezItMan · 2020-10-15T19:10:31Z

test/workspace_test.rb

+    expect(@workspace.show_details).must_equal "This user's id is: USLACKBOT, the username is: slackbot and their real name is: Slackbot. They have a status emoji of: N/A and their status text is: N/A"
+  end
+
+  it "can post message to channel and return true" do


What about posting messages when there is no selected channel/user?

indiakato and others added 30 commits October 6, 2020 10:36

update test helper vcr and simplecov

cf13667

made workspace class with initialize method

5e8cfc9

test printing resonse from users.list slack API

af96987

small changes, set up User Class

fba233e

add .idea/ to gitignore

c3077ca

Added User method and related parts

6392025

get all users + user test

13c6c31

added channel_test file and 1 test for Channel Class and minor change…

068e8d7

…s throughout

added channel class and tests for channel

7e934e0

Added username and id as attributes in user class

9eb1c83

Adding main code for getting choice/printing results

d09c02d

added comment

fbfa3c9

minor reorder in User class attributes, finish printing users list & …

3c904ff

…options in driver code

adding printing for list of channels & minor change to order of Chann…

7486479

…el attributes

added comments and tried table print

b207eb4

call API in recipient class, list_all abstract class, list_all in use…

8c2bb7a

…r and channel

add inheritance for User & Channel classes, update tests for .list_al…

8943a7a

…l method

select user and select channel methods

376426a

added workspace test file & tests

e3a0142

add tests for select_channel

089fea0

add cassettes

6f1ae30

add details method to recipient, user and channel, updated slack.rb t…

03b62a7

…o run added options

added test for show details method, added attribute @selected to Work…

5890086

…space & updated select channel & user accordingly

Added send_message method to workspace & recipient classes

faf2b63

added send_message test in workspace, put send message option in driv…

41f1836

…er code

add helper methods to slack.rb, add method for filling empty string f…

2b6472e

…or Channel topic

add error raise in recipient class, in slack.rb got the table printin…

5b6bc2c

…g working.

deleted some white space

ea7c181

took out recipient variable and used workspace.selected instead

182a9a3

refactor in slack.rb, in recipient class change @name to @slack_id to…

0d93bf5

… send message to users

added slackapierror test

17a9fc6

CheezItMan reviewed Oct 15, 2020

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

India and Richelle - Water #12

India and Richelle - Water #12

indiakato commented Oct 9, 2020

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

		@@ -0,0 +1,45 @@
		class SlackApiError < StandardError; end

		class Recipient

		@@ -0,0 +1,17 @@
		require_relative 'test_helper'

		describe "Channel class" do

		@@ -0,0 +1,26 @@
		require_relative 'test_helper'

		describe "User class" do

India and Richelle - Water #12

Are you sure you want to change the base?

India and Richelle - Water #12

Conversation

indiakato commented Oct 9, 2020

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

CheezItMan Oct 15, 2020

Choose a reason for hiding this comment