Leaves - Kristina & Ga-Young #8

krismosk · 2019-09-13T22:10:55Z

slack.rb

Congratulations! You're submitting your assignment!

You and your partner should collaborate on the answers to these questions.

Comprehension Questions

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 read through the documentation closely and it was pretty helpful because we were better informed about required vs optional arguments and how to handle anticipated errors. For our next project, we would be more comfortable reading through the documentation first and also understand that not all documentation is the same and customizing API calls might involve some online research.
Give a short summary of the request/response cycle. Where does your program fit into that scheme?	Request: When the program starts, a request is made to the API. Processing: API generates all users and channels within Workspace. Then the User interacts with the CLI and an additional API call is made when they want send a message to a user or channel.
How does your program check for and handle errors when using the Slack API?	We create a custom exception class called SlackAPIError that inherits from StandardError, if the response from the API has an error, we catch the error and output a readable message to the user indicating what went wrong.
Did you need to make any changes to the design work we did in class? If so, what were they?	We removed the recipient class and we removed any inheritance relationship between recipient and user and channel. We put recipient's responsibility as a instance variable "selected" in the Workspace class. Also, Workspace does all of the heavy lifting/communication in our program, user and channel are light-weight classes that only know about themselves.
Did you use any of the inheritance idioms we've talked about in class? How?	Besides our custom error inheritance, we have no other inheritance relationships in our program. However, channel and user are polymorphic classes and each implement the same types of methods.
How does VCR aid in testing a program that uses an API?	It captures/records an API call and re-uses it for testing purposes. This allows you to conserve API call usage.

…or now.

…me, Slack ID to the console.

…riable @users.

…responding tests.

…ng tests.

…s. Updated slack.rb. Wave 2 Completed.

… posted message to channel. Passed corresponding tests.

… channel name or channel id.

…. Passed corresponding tests. Wave 3 complete.

beccaelenzil · 2019-09-19T17:10:19Z

slack.rb

What We're Looking For

Feature	Feedback
Core Requirements
Git hygiene (no slack tokens)	check
Comprehension questions	check
Functionality
List users/channels	check
Select user/channel	check
Show details	check
Send message	check
Program runs without crashing	check
Implementation
API errors are handled appropriately	We do not have the tools yet to test a bad get request in this instance, but it is good to think about and build in functionality to deal with bad requests.
Inheritance model matches in-class activity	no
Inheritance idioms (abstract class, template methods, polymorphism) used appropriately	not used
Methods are used to break work down into simpler tasks	consider breaking down CLI functionality into methods
Class and instance methods are used appropriately	no class methods
Tests written for User functionality	yes - in workspace_test
Tests written for Channel Functionality	yes - in workspace_test
Tests written for sending a message	yes
Overall	Good work overall. This code is well-written and well-tested. The requirements around understanding the request/response cycle and consuming an API were met.

One of the key learning goals for this project was implementing a design using inheritance. I have left an inline comment demonstrating one place where using inheritance would have resulted in a less dependent design. Let's talk about the benefits of template methods and inheritance at our next one on one.

beccaelenzil · 2019-09-19T16:53:05Z

lib/slack.rb


+  puts prompt
+
+  while command = gets.chomp.downcase


Consider using helper methods to encapsulate some of the functionality in this CLI.

beccaelenzil · 2019-09-19T16:55:24Z

lib/workspace.rb

+      return result
+    end
+
+    def search(data_source, query_term)


This code is very similar to select a user and select a channel. Could you DRY this up somehow?

beccaelenzil · 2019-09-19T17:00:58Z

lib/workspace.rb

+      return HTTParty.get(url, query: query_parameters)
+    end
+
+    def user_list


What you've done here works. Nice work! However, the recommendation to put this method in the user class was there to reduce dependencies between classes. When you instantiate a new User below, this means that Workspace needs to know everything about User. This is a perfect situation for a class method.

beccaelenzil · 2019-09-19T17:05:12Z

lib/workspace.rb

+      query_parameters = {
+        token: ENV['SLACK_TOKEN']
+      }
+      return HTTParty.get(url, query: query_parameters)


Make sure you handle bad requests appropriately.

beccaelenzil · 2019-09-19T17:06:19Z

test/workspace_test.rb

@@ -0,0 +1,238 @@
+require_relative 'test_helper'
+
+describe "Workspace" do


Thorough tests. Nice work!

beccaelenzil · 2019-09-19T17:15:58Z

lib/slack.rb

+        puts options
+        while selected_command = gets.chomp.downcase
+          case selected_command
+          when "main menu"


Consider adding the options "show details" and "send message" to the main menu so that user of the CLI can send a second message to an already selected recipient.

beccaelenzil · 2019-09-19T17:18:35Z

lib/slack.rb

+          else
+            puts "Invalid input. Returning to main menu..."
+            puts prompt
+            break


Consider allowing users to re-enter their input rather than breaking the program when the user input is invalid.

krismosk added 30 commits September 9, 2019 16:25

Started token verification.

4349d08

Completed API token verification script.

6bced36

Modified token verification loop sytax for readability.

0913ab4

Added filter for sensitive data to protect Slack token identity.

f9e9110

Created acceptor, user lib files.

185bc2a

Instantiated User class, created first test. Commented out Acceptor f…

55e1d8a

…or now.

Added .get_api method to User class. Passed corresponding test.

361380a

Created .list method for User and passed corresponding test.

b41d1da

Created a .print_list method for User, to print the username, real na…

20bf96d

…me, Slack ID to the console.

Added new channel and workspace files.

14588c4

Formatted CLI Main to re-print commands when given bad input

9ffa927

Removed line in .gitignore so that VCR cassettes can be tracked.

f5e5b96

Created scaffolding for Workspace

1dbdd9f

Scaffolding workspace/user composition.

59afa96

Moved user methods inside of Workspace. Work in progress.

f4fe774

Successfully instantiated Workspace, creates users within instance va…

f7a7f41

…riable @users.

Wrote test for workspace intialize and workspace get_api test passing

02c4e54

Modified user test to only test for intialized attributes.

006161e

Created Channel class, tested instantation of class. Test passing.

26454d6

Wave 1 completed.

5d0d7c1

work in progress

1edf180

Created search method in Workspace to search across users, passed cor…

202adb8

…responding tests.

Created show_details method, implemented for User. Passed correspondi…

2e5fbb4

…ng tests.

Modified search method to search through channels. Passed correspondi…

f98a3b2

…ng tests.

Modified show details to work for channels. Passed corresponding test…

7520454

…s. Updated slack.rb. Wave 2 Completed.

Created send message method in Workspace. Successfully called API and…

9f8acc0

… posted message to channel. Passed corresponding tests.

Modified CLI program to allow user to send a message to a channel via…

8e750a9

… channel name or channel id.

Modified CLI program to allow user to send a message to selected user…

b71f28a

…. Passed corresponding tests. Wave 3 complete.

Removed acceptor class and file.

3ba429c

Cleaned up workspace test.

22c9cf2

krismosk added 2 commits September 13, 2019 13:25

Removed all references to acceptor.rb

a8df6c0

Completed project.

a55e36f

beccaelenzil reviewed Sep 19, 2019

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Leaves - Kristina & Ga-Young #8

Leaves - Kristina & Ga-Young #8

Uh oh!

krismosk commented Sep 13, 2019

Uh oh!

beccaelenzil commented Sep 19, 2019 •

edited

Loading

Uh oh!

beccaelenzil Sep 19, 2019

Uh oh!

beccaelenzil Sep 19, 2019

Uh oh!

beccaelenzil Sep 19, 2019

Uh oh!

beccaelenzil Sep 19, 2019

Uh oh!

beccaelenzil Sep 19, 2019

Uh oh!

beccaelenzil Sep 19, 2019

Uh oh!

beccaelenzil Sep 19, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

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

		describe "Workspace" do

Leaves - Kristina & Ga-Young #8

Are you sure you want to change the base?

Leaves - Kristina & Ga-Young #8

Uh oh!

Conversation

krismosk commented Sep 13, 2019

slack.rb

Comprehension Questions

Uh oh!

beccaelenzil commented Sep 19, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

slack.rb

What We're Looking For

Uh oh!

beccaelenzil Sep 19, 2019

Choose a reason for hiding this comment

Uh oh!

beccaelenzil Sep 19, 2019

Choose a reason for hiding this comment

Uh oh!

beccaelenzil Sep 19, 2019

Choose a reason for hiding this comment

Uh oh!

beccaelenzil Sep 19, 2019

Choose a reason for hiding this comment

Uh oh!

beccaelenzil Sep 19, 2019

Choose a reason for hiding this comment

Uh oh!

beccaelenzil Sep 19, 2019

Choose a reason for hiding this comment

Uh oh!

beccaelenzil Sep 19, 2019

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

beccaelenzil commented Sep 19, 2019 •

edited

Loading