Leaves - Mariya Burrows & Morgan Schuler #21

M-Burr · 2019-09-14T04:19:22Z

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 carefully read the documentation on the provided links for users, channels, and message. This documentation was helpful and gave us a good idea of what to expect from an API response. We also used this documentation to identify what information we wanted (e.g., for our details method) and also what was required vs. optional in our query parameters. We would definitely recommend spending time in the beginning to understand API documentation.
Give a short summary of the request/response cycle. Where does your program fit into that scheme?	1) Request - sends an API request to the server when the program starts. 2) The server processes the request to determine if the request (e.g., get vs. post) is valid and/or if the query parameters are valid. 3)The server sends a response back. The response may have the information you want, or it may have an error response (e.g., 400 codes). Our program makes requests to the Slack API, and the Slack server responds our program.
How does your program check for and handle errors when using the Slack API?	We raise an APIError unless the response has a 200 code.
Did you need to make any changes to the design work we did in class? If so, what were they?	We were able to follow the class design. We originally made an instance method of .list, but realized that would be difficult to work with, & then restructured our code to create a class method for list (as was originally recommended in the class design). This made our whole program run more smoothly.
Did you use any of the inheritance idioms we've talked about in class? How?	We used polymorphism in our .details and .send_message methods. This allowed us to treat different class objects (i.e., user vs. channel) the same by calling the same methods (i.e., .details, .send_message) on both classes.
How does VCR aid in testing a program that uses an API?	It captures/"tapes" our API calls & then uses that recording to check against for our tests (rather than calling the API repeatedly during the testing process).

… working on methods for list vs. details & how that interacts with slack.rb

beccaelenzil · 2019-09-18T20:49:11Z

slack.rb

What We're Looking For

Feature	Feedback
Core Requirements
Git hygiene (no slack tokens)	check - see comment
Comprehension questions	check
Functionality
List users/channels	check
Select user/channel	check
Show details	see comment
Send message	check
Program runs without crashing	check
Implementation
API errors are handled appropriately	for post, yes. for get, no. -- see comment
Inheritance model matches in-class activity	check
Inheritance idioms (abstract class, template methods, polymorphism) used appropriately	check
Methods are used to break work down into simpler tasks	check -- may be able to make methods more flexible to DRY up your code.
Class and instance methods are used appropriately	check
Tests written for User functionality	see comment
Tests written for Channel Functionality	check - see comment
Tests written for sending a message	check
Overall	Excellent job overall. It is clear to me that the learning goals around understanding the request/response cycle, consuming and API, and implementing a design using inheritance from scratch were all met. The main focus of my inline comments were on your user interface. In particular, do your make methods flexible to DRY up your code and be sure to deal appropriately (and test!) for invalid user input.

beccaelenzil · 2019-09-18T19:52:08Z

.gitignore

 /tmp/

 # Used by dotenv library to load environment variables.
 # .env


You should uncomment this line to include it in your .gitignore file.

beccaelenzil · 2019-09-18T20:08:39Z

lib/channel.rb

+
+      channel_details["slack_id"] = self.slack_id
+      channel_details["name"] = self.name
+      channel_details["topic"] = self.topic


the "topic" key provides this hash: {"value"=>"Non-work banter and water cooler conversation", "creator"=>"UMZNG8T8R", "last_set"=>1568061999} It seems that you just want "value" in this case.

beccaelenzil · 2019-09-18T20:13:10Z

lib/recipient.rb

+    end
+
+    def self.get(url, params)
+      return HTTParty.get(url, query: params)


What is this isn't a success? Make sure you are prepared for something to go wrong and raise a SlackAPIError.

beccaelenzil · 2019-09-18T20:15:11Z

lib/slack.rb

+      ["List users", "List channels", "Quit"]
+    )
+
+    # path for list users


Consider using case/when for this control structure.

beccaelenzil · 2019-09-18T20:15:51Z

lib/slack.rb

+      )
+
+      # user decides how they want to look up recipient
+      if search_choice == "1"


With these nested conditionals, make sure that users always have the option to quit.

beccaelenzil · 2019-09-18T20:19:21Z

lib/workspace.rb

+      @selected = nil
+    end
+
+    def select_user_slack_id(slack_id: nil)


The following 4 methods are all quite similar. Is there a way to DRY up this code?

beccaelenzil · 2019-09-18T20:19:25Z

lib/slack.rb

+end

-  puts "Thank you for using the Ada Slack CLI"
+def print_user_list(list)


print_user_list and print_channel_list are quite similar. Is there a way to dry up this code?

beccaelenzil · 2019-09-18T20:22:27Z

test/workspace_test.rb

+      end
+    end
+
+    it "selects user by slack_id" do 


What if the recipient you try to select doesn't exist? What happens to a previously selected user if you try to select a bad user? Remember you always need to test for positive and negative results.

beccaelenzil · 2019-09-18T20:23:55Z

test/workspace_test.rb

+        @workspace.select_channel_slack_id(slack_id: "HASFHAS")
+      end
+
+      expect{


It is not clear from the name of this test why this raises a standard error.

beccaelenzil · 2019-09-18T20:36:10Z

test/channel_test.rb

+        expect(@channel.details).must_be_kind_of Hash
+      end
+
+      it "has a slack_id" do


Include tests for the other details.

M-Burr added 18 commits September 10, 2019 16:14

"set up classes and created abstract methods and recipients"

cb16b56

Added channel list. Needs correct id in test

2ab30dc

updated channel code

b995d02

added initialize & list method for user with corresponding tests

95d0309

added psuedo code. Currently passing all tests.

69ccdb3

added send_msg method & corresponding tests. All tests are passing.

65ca245

added slack.rb skeleton

1093fe4

updated workspace.rb & corresponding tests; added slack.rb. Currently…

18095fd

… working on methods for list vs. details & how that interacts with slack.rb

fixed the bug in user.rb

fc33e75

updated self.list method in user class and updated user class tests

84dc85e

added details method

4dee563

updated complete (but un-refactored) Slack CLI

86f64e0

updated channel test

e22c696

Added tests to all files

efd3245

updated tests. fixed infinite loop inside of slack.rb

0f4f4d2

deleted unused file

6482cd2

added formating in slack.rb

b78d0ad

removed extra file

5768e56

beccaelenzil reviewed Sep 18, 2019

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Leaves - Mariya Burrows & Morgan Schuler #21

Leaves - Mariya Burrows & Morgan Schuler #21

Uh oh!

M-Burr commented Sep 14, 2019

Uh oh!

beccaelenzil commented Sep 18, 2019

Uh oh!

beccaelenzil Sep 18, 2019

Uh oh!

beccaelenzil Sep 18, 2019

Uh oh!

beccaelenzil Sep 18, 2019

Uh oh!

beccaelenzil Sep 18, 2019

Uh oh!

beccaelenzil Sep 18, 2019

Uh oh!

beccaelenzil Sep 18, 2019

Uh oh!

beccaelenzil Sep 18, 2019

Uh oh!

beccaelenzil Sep 18, 2019

Uh oh!

beccaelenzil Sep 18, 2019

Uh oh!

beccaelenzil Sep 18, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Leaves - Mariya Burrows & Morgan Schuler #21

Are you sure you want to change the base?

Leaves - Mariya Burrows & Morgan Schuler #21

Uh oh!

Conversation

M-Burr commented Sep 14, 2019

slack.rb

Comprehension Questions

Uh oh!

beccaelenzil commented Sep 18, 2019

slack.rb

What We're Looking For

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants