Ports - Heather and Mina #12

minams · 2019-03-22T22:44:42Z

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 and the provided Slack documentations to explore the Slack API. Using this combination will be helpful for the next project as well.
Give a short summary of the request/response cycle. Where does your program fit into that scheme?	The program requested from the Slack API information about the User, Channel, and to Post Message. The Slack API responded with details on User and Channel. In regards to the Post Message, we received information on the posted message.
How does your program check for and handle errors when using the Slack API?	The program API responded with a true instead of false. We wrote tests to ensure that user inputted value returns what we expected from the API, i.e. "general" channel returned name and ID.
Did you need to make any changes to the design work we did in class? If so, what were they?	We partially implemented the parent class. We wanted to inherit the get method from the parent class but didn't yet.
Did you use any of the inheritance idioms we've talked about in class? How?	Yes, in the initialize method of the child class. If we had more time, our next step was to inherit the get class as well.
How does VCR aid in testing a program that uses an API?	It was able to run faster since it didn't need to make a request to the Slack API. Also, we could run the tests offline.

…tests

…t channel method

CheezItMan · 2019-03-31T22:17:47Z

slack.rb

What We're Looking For

Feature	Feedback
Core Requirements
Git hygiene (no slack tokens)	Good number of commits and good commit messages. No Slack token in git too!
Comprehension questions	Check
Functionality
List users/channels	Check
Select user/channel	Check, but see my inline notes about how it's awkward
Show details	Check
Send message	Check
Program runs without crashing	Check
Implementation
API errors are handled appropriately	Check
Inheritance model matches in-class activity	For the most part, your Workspace class is really just a collection of class methods, and you missed some opportunities for inheritance with `User` and `Channel`.
Inheritance idioms (abstract class, template methods, polymorphism) used appropriately	Check
Methods are used to break work down into simpler tasks	Check
Class and instance methods are used appropriately	You've overused class methods in `Workspace`.
Overall	Well done, you hit the learning goals of the project nice work. See my inline notes and let me know any questions you have.

CheezItMan · 2019-03-31T22:05:46Z

lib/slack.rb

+    case selection
+    when "list channels"
+      puts Slack::Workspace.all_channels_details
+    when "select channel"


The way you have this here means the channel doesn't stay selected. It also means you have a lot of duplicate code in selecting users and channels and sending messages etc.

CheezItMan · 2019-03-31T22:07:25Z

lib/user.rb

+    def self.get
+      url = "https://slack.com/api/users.list"
+      params = {
+        token: ENV["KEY"],


In general don't name your environmental variable "KEY", make the name a bit more specific.

Also both the token and the URL would make great constants.

CheezItMan · 2019-03-31T22:09:04Z

lib/channel.rb

+      @topic = topic
+    end
+
+    def self.get


You could implement this method in Recipient and inherit the behavior.

CheezItMan · 2019-03-31T22:09:34Z

lib/recipient.rb

+
+      message_request = HTTParty.post(url, query: params)
+      if message_request["ok"] == false
+        raise ArgumentError, "Request is unsuccessful"


You should also include the error message.

CheezItMan · 2019-03-31T22:11:43Z

lib/workspace.rb

+Dotenv.load
+
+module Slack
+  class Workspace


This works as a collection of class methods, but if you're using all class methods, you might as well just make Workspace a module. Instead I would suggest making Workspace a class with the attributes @users, @channels and @selected, which means you could keep track of the selected user or channel in your main app.

CheezItMan · 2019-03-31T22:12:37Z

specs/recipient_spec.rb

+    expect(receiver).must_be_instance_of Slack::Recipient
+  end
+end
+


You should also test that your abstract method raises an error.

CheezItMan · 2019-03-31T22:12:48Z

specs/slack_spec.rb

@@ -0,0 +1 @@
+


CheezItMan · 2019-03-31T22:13:31Z

specs/workspace_spec.rb

@@ -0,0 +1,106 @@
+require_relative "test_helper.rb"
+


In this file you also need to have some negative-case tests with invalid arguments.

minams and others added 30 commits March 18, 2019 16:58

testing slack

904bd3f

Updated Slack API test

0afb27b

Updated test_helper file for VCR

49e3afa

added Recipient parent class and initialized

f6b7471

changed git file

7c9d55b

made some changes to initialize

37897a0

Channel class self.get method

b8a1fa8

added User class and initial tests

8115f60

created self.list_all method in user class

8e47965

made minor name changes

7e223d5

channel list_all method and test

da766d5

changes in recipient file

e611d21

channel list method in progress

573b950

added channel info to list_all method

f277f55

updated list_all methods

389301d

Accessedlist_all methods via Slack.rb file

2096753

Added workspace class

0be2280

added methods to Workspace for details about selected classes

e8ed772

Added select_channel and select_user methods to workspace class with …

8cbafb2

…tests

added UI to slack.rb

a9aaaa6

refactored some of CLI and workspace chanels output

41c015d

updated tests for list_all methods for channel and user classes

7c51117

Merge branch 'master' of https://github.com/minams/slack-cli

f3436e8

added message methods to slack.rb for now

a7a0cc6

Added tests for workspace, working on method to list channel details

b63fb6c

working on selected channel details

9039c1e

made minor syntax changes

f4ee723

made changes to selected_channel_details method in workspace

8e924df

Finished list channel/user details method and CLI, added test for lis…

3764283

…t channel method

added tests for workspace, moved post message method to recipient class

f58feb9

minams and others added 6 commits March 22, 2019 11:25

completed slack prompt for details

acd65e2

Started message method in workspace

8249ccd

added send message feature in slack.rb

ad6efe6

added 2 when to selection case

4ecb3fb

refactor

b14f42d

removed ap and re-added method in workspace.rb and spec

5a0cd37

CheezItMan reviewed Mar 31, 2019

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ports - Heather and Mina #12

Ports - Heather and Mina #12

minams commented Mar 22, 2019

CheezItMan commented Mar 31, 2019

CheezItMan Mar 31, 2019

CheezItMan Mar 31, 2019

CheezItMan Mar 31, 2019

CheezItMan Mar 31, 2019

CheezItMan Mar 31, 2019

CheezItMan Mar 31, 2019

CheezItMan Mar 31, 2019

CheezItMan Mar 31, 2019

Ports - Heather and Mina #12

Are you sure you want to change the base?

Ports - Heather and Mina #12

Conversation

minams commented Mar 22, 2019

slack.rb

Comprehension Questions

CheezItMan commented Mar 31, 2019

slack.rb

What We're Looking For

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