Ports - Margaret and Ari by aribray · Pull Request #5 · Ada-C11/slack-cli

aribray · 2019-03-22T20:32:32Z

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 used Postman to check the API response. We also used the Slack API documentation to make sure our response matched the expected response. In the future, using Postman will really help visualize the expected response.
Give a short summary of the request/response cycle. Where does your program fit into that scheme?	The client is our program, and the server is the Slack API. The details of the request are in either the .get or .post verbs. The details about the response come back in JSON format.
How does your program check for and handle errors when using the Slack API?	It checks if we have a valid token and raises a SlackError (which inherits from StandardError) if the token is invalid. It checks if the ["ok"] value is true. We don't check for the 200 status code because the SlackAPI always returns that. We also test for invalid user names and channel names and raise a SlackError if found.
Did you need to make any changes to the design work we did in class? If so, what were they?	In our original UML, we didn't have a Workspace. As we were working in the CLI, we realized that many of our methods could live in a Workspace and this will make our program more flexible for future changes.
Did you use any of the inheritance idioms we've talked about in class? How?	Yes, we used inheritance for the get method and for the send message method. We used it for these methods because they were very similar for both user and channel classes.
How does VCR aid in testing a program that uses an API?	The VCR aids in testing a program that uses an API because it records the API call and you only need to do it once, not every time that you run your tests. This speeds up testing and reduces cost (if the API call is not free).

…nning

…ils method & tests to user

… channel details to accomodate table print. Updated slack.rb to use table print

… workspace. Moved associated tests to workspace

CheezItMan · 2019-03-31T20:38:48Z

slack.rb

What We're Looking For

Feature	Feedback
Core Requirements
Git hygiene (no slack tokens)	Good number of commits and good commit messages
Comprehension questions	Check
Functionality
List users/channels	Check
Select user/channel	Check, but I can't use the ID field
Show details	Check
Send message	Check
Program runs without crashing	Yes, but if I have an invalid user selected the app crashes
Implementation
API errors are handled appropriately	Your library code is raising errors properly, but your UI doesn't handle them when they get raised.
Inheritance model matches in-class activity	NOPE
Inheritance idioms (abstract class, template methods, polymorphism) used appropriately	Well done, good use of inheritance
Methods are used to break work down into simpler tasks	For the most part, see my inline comments for some of your UI.
Class and instance methods are used appropriately	Your `User` and `Channel` classes could be used to create objects representing individual users or channels. Then they could inherit the `send_msg` method resulting in a more flexible design by using duck typing.
Overall	Not bad, you hit most of the learning goals. See my comments inline and let me know if you have questions. The biggest issues you have to work on are OO Design, see my notes on Channel and User and check out the instructor reference solution.

CheezItMan · 2019-03-31T19:37:10Z

lib/slack.rb

-  # TODO project
-
-  puts "Thank you for using the Ada Slack CLI"
+  until response == "7" || response == "quit"


Oh thank god you respond to the numbers!

CheezItMan · 2019-03-31T20:30:03Z

lib/workspace.rb

+
+      selected_user = ""
+
+      response["members"].each do |member|


You could also use the .find method as well.

CheezItMan · 2019-03-31T20:30:32Z

specs/channel_spec.rb

+      expect(response.length).must_equal 3
+    end
+  end
+  it "will raise an error if given an invalid key" do


CheezItMan · 2019-03-31T20:31:47Z

specs/workspace_spec.rb

+end
+
+describe "see_details" do
+  it "shows details for selected user" do


What about when no user has been selected. You also have 2 describe blocks with the same "see_details" description... Little odd

CheezItMan · 2019-03-31T20:34:07Z

lib/slack.rb

-
-  puts "Thank you for using the Ada Slack CLI"
+  until response == "7" || response == "quit"
+    if response == "list users" || response == "1"


This set of if-else blocks, really looks like it could be broken up into methods.

CheezItMan · 2019-03-31T20:34:51Z

lib/user.rb

+
+      if response["ok"]
+        response["members"].each do |member|
+          user_list << {"name" => member["name"], "real name" => member["real_name"], "slack id" => member["id"]}


This method would make more sense if it returned a list of User instances with name, read name and id properties.

CheezItMan · 2019-03-31T20:35:41Z

lib/channel.rb

+        raise SlackAPI::SlackError, "There was an error. The error message is #{response["error"]}"
+      else
+        response["channels"].each do |channel|
+          channel_list << { "name" => channel["name"], "topic" => channel["topic"]["value"], "member count" => channel["members"].length, "id" => channel["id"] }


You have missed an opportunity to create an array of Channel instances instead of an array of hashes.

msfinnan and others added 24 commits March 19, 2019 12:27

Created verification.rb to check connection to Slack API.

0690957

Wrote first test for channel class (list_channels)

de7b750

passed tests for list_channel method

3268e0c

Trying to solve git pull issue

92c9449

Fixed git pull issue

e27145f

Added tests for user, wrote method to pass tests, got slack.rb CLI ru…

8c63b50

…nning

Wrote tests and code for select user method

4468323

Added tests and methods for select channel

e646028

Started details part of slack.rb

806f6cd

moved dotevn to test_helper file

a588b63

Added module, added SlackError & tests for SlackError, added see_deta…

38cd541

…ils method & tests to user

added tests for user details. Trying to fix cli for details prompt

53c7eac

fixed bug in details output in CLI, added recipient.rb

dd1a21c

added recipient class and made User and Channel inherit from recipient

7d2956a

Added send msg method to channel class and wrote test

948b30b

Wrote send_msg tests and code for user and channel

6c9e142

Added CLI code for send_msg method

e5099a6

Fixed test error for selected user response

8821a24

Changed data structure for list user, list channel, user details, and…

33211e7

… channel details to accomodate table print. Updated slack.rb to use table print

Added send message method to Recipient class and updated CLI

ec223d6

added tests for error message

a7cec70

Added workspace and moved see_details and select_recipient methods to…

6470849

… workspace. Moved associated tests to workspace

Updated formatting and functionality on slack.rb

6934c0c

Removed commented out code

63a8f96

CheezItMan reviewed Mar 31, 2019

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ports - Margaret and Ari#5

Ports - Margaret and Ari#5
aribray wants to merge 24 commits intoAda-C11:masterfrom
aribray:master

aribray commented Mar 22, 2019

Uh oh!

CheezItMan commented Mar 31, 2019

Uh oh!

CheezItMan Mar 31, 2019

Uh oh!

CheezItMan Mar 31, 2019

Uh oh!

CheezItMan Mar 31, 2019

Uh oh!

CheezItMan Mar 31, 2019

Uh oh!

CheezItMan Mar 31, 2019

Uh oh!

CheezItMan Mar 31, 2019

Uh oh!

CheezItMan Mar 31, 2019 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

Conversation

aribray commented Mar 22, 2019

slack.rb

Comprehension Questions

Uh oh!

CheezItMan commented Mar 31, 2019

slack.rb

What We're Looking For

Uh oh!

CheezItMan Mar 31, 2019

Choose a reason for hiding this comment

Uh oh!

CheezItMan Mar 31, 2019

Choose a reason for hiding this comment

Uh oh!

CheezItMan Mar 31, 2019

Choose a reason for hiding this comment

Uh oh!

CheezItMan Mar 31, 2019

Choose a reason for hiding this comment

Uh oh!

CheezItMan Mar 31, 2019

Choose a reason for hiding this comment

Uh oh!

CheezItMan Mar 31, 2019

Choose a reason for hiding this comment

Uh oh!

CheezItMan Mar 31, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

CheezItMan Mar 31, 2019 •

edited

Loading