Slack CLI

hn4ever · 2020-10-09T17:59:37Z

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?	Creating an API was a fundemental thing we needed to learn , we had the opporunity to understand how to securly access the needed data by keeping our token hidden and secure using .env and .gitignore (a good practice that we will continue). We were also able to use Postman to test our parameters and token.
Give a short summary of the request/response cycle. Where does your program fit into that scheme?	Basicly we are requesting the data from the API and we are reciving the response in a form of a JSON file.
How does your program check for and handle errors when using the Slack API?	We used VCR cassettes to record the response (of API requests) in order to test it.
How did the design and organization of your project change over time?	At first we weren't aware of the suggested instructor design so we created our own version, our design is attached in images file and also its URL is: here. In slackRecord class we created the methods to access the data from API, and then we created a recipient class in which User and Channel Class were inheriting from.
Did you use any of the inheritance idioms we've talked about in class? How?	In Recipients Class, We used details method as a template method that we later edited it in User and Channel class. We designed the Recipient class to be an Abstract class.
How does VCR aid in testing a program that uses an API?	Using VCR is a stable tool so even when there is no internet we are able to access saved "cassettes" that recorded the response from the API. We were able to access the data and test it.

dHelmgren

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.	I initially thought your assignment was incomplete because you are missing appropriate error handling code! see comments
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.	✔️ see comments!
Practices clean code. `lib/slack.rb` only interacts with `Workspace` to show a separation of responsibilities. Complex logic is broken into smaller helper methods.	✔️ I think you did OK but see comments
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`)	couldn't find it
Practices git with at least 15 small commits and meaningful commit messages	only 10 :'(

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	encountered a crash

Overall Feedback

Overall Feedback	Criteria	yes/no
Green (Meets/Exceeds Standards)	7+ in Code Review && 3+ in Functional Requirements
Yellow (Approaches Standards)	6+ in Code Review && 2+ in Functional Requirements	✔️
Red (Not at Standard)	0-5 in Code Review or 0,1 in Functional Reqs, or assignment is breaking/doesn’t run with less than 5 minutes of debugging

Additional Feedback

This is a fairly solid program, but I do want to highlight something important here: the biggest problem that this submission has is the lack of error handling! It caused several knock-on errors that would have been pretty easy to fix but instead dragged down your grade on an otherwise really good submission.

dHelmgren · 2020-10-27T23:12:13Z

.gitignore

+.floo
+.flooignore


Thank you!!!!

dHelmgren · 2020-10-27T23:15:15Z

lib/Slack_record.rb

+require 'httparty'
+require 'dotenv'
+
+Dotenv.load
+
+BASE_URL_CONVERSATIONS = 'https://slack.com/api/conversations.list'
+BASE_URL_USERS = 'https://slack.com/api/users.list'
+BASE_URL_CHAT = 'https://slack.com/api/chat.postMessage'


This is a pretty big deviation from the design you were asked to use! Most of the following comments talk about how this was expected to be in the original design!

dHelmgren · 2020-10-27T23:17:50Z

lib/Slack_record.rb

+    return response["channels"]
+  end
+
+  def self.chat(message,channel)


This can just live in recipient as is! no changes! :D

dHelmgren · 2020-10-27T23:21:01Z

test/test_helper.rb

@@ -25,5 +27,7 @@
  }

  # Don't leave our token lying around in a cassette file.
-
+  config.filter_sensitive_data("<SLACK_API_TOKEN>") do
+    ENV["SLACK_API_TOKEN"]


I think calling this SLACK_API_TOKEN instead of SLACK_TOKEN is fine in principle, but I also think it might have scuttled the results of your tests in Learn.

dHelmgren · 2020-10-27T23:21:36Z

lib/workspace.rb

+  def initialize
+    @users = User.list_users
+    @channels = Channel.list_channels
+    @selected = nil
+  end
+
+  def select_user(user_input)
+    @users = User.list_users
+    @selected = @users.find {|user| user.user_name == user_input || user.slack_id == user_input}
+  end
+
+
+  def select_channel(user_input)
+    @channels = Channel.list_channels
+    @selected = @channels.find {|channel| channel.name == user_input || channel.slack_id == user_input}
+  end


Just popping in to say that this is really lovely to read. :D

Thank you Devin :)

dHelmgren · 2020-10-27T23:22:27Z

lib/slack.rb

+    when "1", "list users"
+      tp workspace.users, :real_name, :user_name, :slack_id
+    when "2", "list channels"
+      tp workspace.channels, :name, :topic, :member_count, :slack_id
+    when "3", "select user"


This could be a touch more readable!

Suggested change

when "1", "list users"

tp workspace.users, :real_name, :user_name, :slack_id

when "2", "list channels"

tp workspace.channels, :name, :topic, :member_count, :slack_id

when "3", "select user"

when "1", "list users"

tp workspace.users, :real_name, :user_name, :slack_id

when "2", "list channels"

tp workspace.channels, :name, :topic, :member_count, :slack_id

when "3", "select user"

Etc!

sorry I'm confused, I didn't understand what you meant by Etc

dHelmgren · 2020-10-27T23:23:16Z

lib/slack.rb

+      print "Please enter a channel's name or ID:"
+      selection_option = gets.chomp
+      selected = workspace.select_channel(selection_option)
+      if selected
+        puts "Channel found"
+      else
+        puts "Channel not found"
+      end


you might even consider taking these longer pieces and putting them in helper methods!

dHelmgren · 2020-10-27T23:24:31Z

test/workspace_test.rb

+  describe "show details" do
+    it "shows details selected user/channel" do
+      VCR.use_cassette(" workspacce channels") do
+        workplace = Workspace.new
+
+        expect(workplace.selected).must_be_nil
+
+      end
+    end
+  end


No test for sending messages?

dHelmgren · 2020-10-27T23:31:16Z

lib/slack.rb

+      begin
+        puts workspace.show_details
+      rescue WorkspaceError => error
+        puts error.message
+      end


begin and rescue should also be used on anything that sends a message to slack, to better handle those errors!

hn4ever and others added 10 commits October 5, 2020 17:50

Setup ENV

ac73d9e

wave1 : user class finished

64fc425

wave1: implemented slack functionality

4c3eb76

Finished wave1

72a7b57

finished wave2 methods (without the tests)

908b59c

finished wave 2 (with tests)

9e7e581

Started wave 33

89f2f6f

wave 3 able to send message to channel and user

c212ccf

Finalized wave3

a6106e3

Slack CLI UML chart

9dcc1c8

dHelmgren reviewed Oct 27, 2020

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Slack CLI - Fire - Gessica and Noor #10

Slack CLI - Fire - Gessica and Noor #10

hn4ever commented Oct 9, 2020

dHelmgren left a comment

dHelmgren Oct 27, 2020

dHelmgren Oct 27, 2020

dHelmgren Oct 27, 2020

dHelmgren Oct 27, 2020

dHelmgren Oct 27, 2020

hn4ever Oct 27, 2020

dHelmgren Oct 27, 2020

hn4ever Oct 27, 2020

dHelmgren Oct 27, 2020

dHelmgren Oct 27, 2020

dHelmgren Oct 27, 2020

		.floo
		.flooignore

Slack CLI - Fire - Gessica and Noor #10

Are you sure you want to change the base?

Slack CLI - Fire - Gessica and Noor #10

Conversation

hn4ever commented Oct 9, 2020

Assignment Submission: Slack CLI

Reflection

dHelmgren left a comment

Choose a reason for hiding this comment

Slack CLI

Major Learning Goals/Code Review

Functional Requirements

Overall Feedback

Additional Feedback

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment