Ports - Kasey and Elle #15

dev-elle-up · 2019-03-22T22:49:02Z

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 worked individually to explore the Slack API primarily by reading the documentation. We also used Postman to become familiar with the structure of sending GET and POST requests and examine the JSON that was returned.
Give a short summary of the request/response cycle. Where does your program fit into that scheme?	In the request/response cycle, a request is sent to the server that includes query parameters. The server returns a response that contains a header and a body. Our program follows this scheme by first sending a query to the Slack API as a GET request. When the response is received, our program stores the data returned in a variable and then parses the data for use in our program. Similarly, we use a POST request to send a message (request). The response returned contains a parameter which indicates whether the action was successful; we use this in our program to raise an error if it was not successful.
How does your program check for and handle errors when using the Slack API?	We check the response returned by the post request for the parameter "ok" and raise an error if this value is false. These errors are mostly useful for being detected by our tests.
Did you need to make any changes to the design work we did in class? If so, what were they?	We decided not to have Channel and User inherit from a Recipient class.
Did you use any of the inheritance idioms we've talked about in class? How?	We used the pattern of having the SlackError inherit from StandardError.
How does VCR aid in testing a program that uses an API?	VCR reduces the number of API calls your program makes to the server by "recording" the results in a .yml file and then spoofing an API call by playing back the results of the last (recorded) call. This is helpful because API calls may be limited or charged for. It also helps by letting you continue to work if your computer or the server is offline.

…s together (require statements) and circular reference with minitest.

…s selected' to not throw an error and crash. Worked on making 'send message' work on my machine; not done.

…kind of recipient (User or Channel) and set query parameters accordingly. Also put in a couple of catches for user or channel being nil, which can happen if you do 'select user/channel' and enter an invalid selection, and then select 'send message'. This now gets caught and redirects the user to the main prompt instead of crashing. TO DO: One test is now throwing an error. Need to fix test, the code works.

…due to refactoring or being duplicates.

CheezItMan · 2019-03-31T21:24:38Z

slack.rb

What We're Looking For

Feature	Feedback
Core Requirements
Git hygiene (no slack tokens)	Good number of commits and good commit messages except one detailing a wave.
Comprehension questions	Check, nicely detailed answer on the request-response cycle
Functionality
List users/channels	Check
Select user/channel	Check
Show details	Check
Send message	Check
Program runs without crashing	Check, well done
Implementation
API errors are handled appropriately	Check
Inheritance model matches in-class activity	No, y'all made different choices
Inheritance idioms (abstract class, template methods, polymorphism) used appropriately	Not so much.
Methods are used to break work down into simpler tasks	Check
Class and instance methods are used appropriately	Check
Overall	Well done, you hit most of the learning goals. Your design is pretty good, but you missed some opportunities to take advantage of inheritance and duck typing to simplify some of your code. See the instructor reference design and take a look at my inline comments. Let me know if you have any questions.

CheezItMan · 2019-03-31T21:15:27Z

lib/slack.rb

+
+class SlackError < StandardError; end
+
+class Slack


This class would be better named SlackWorkspace since slack can include multiple workspaces.

Also it would be good to wrap everything in a module

CheezItMan · 2019-03-31T21:17:09Z

lib/slack.rb

+    get_lists
+  end
+
+  def get_lists()


Just notice here how the loops look almost identical. This is a good indication that you can dry things up using duck typing / polymorphism.

CheezItMan · 2019-03-31T21:18:21Z

lib/slack.rb

+    end
+
+    url = "https://slack.com/api/chat.postMessage"
+    if recipient.class == Channel


The if and elsif here are identical, so you just need to check to see if recipient is not nil.

CheezItMan · 2019-03-31T21:19:02Z

lib/slack.rb


 def main
-  puts "Welcome to the Ada Slack CLI!"
+  slack = Slack.new


It would be better to have main and the Slack class in separate files.

CheezItMan · 2019-03-31T21:20:03Z

specs/slack_spec.rb

+
+  describe "select users and channels" do
+    it "select a user" do
+      VCR.use_cassette("slack_query") do


You should also test with an invalid user.

CheezItMan · 2019-03-31T21:20:15Z

specs/slack_spec.rb

+      end
+    end
+
+    it "select a channel" do


CheezItMan · 2019-03-31T21:21:01Z

specs/slack_spec.rb

+    end
+  end
+
+  describe "select users and channels" do


This describe seems to include seeing details rather than select user and channels.

You should also test what happens when no user or channel is selected.

You should test with both a user and channel.

CheezItMan · 2019-03-31T21:21:55Z

specs/slack_spec.rb

+      end
+    end
+
+    describe "send_msg" do


Good edge-case tests here.

CheezItMan · 2019-03-31T21:22:32Z

specs/user_spec.rb

@@ -0,0 +1,15 @@
+require_relative "test_helper"


This file doesn't seem to fit here. Also where are tests on the User class.

CheezItMan · 2019-04-02T15:06:32Z

lib/slack.rb

+    }
+    url = "https://slack.com/api/conversations.list?"
+    response = HTTParty.get(url, query: query_parameters)
+    response["channels"].each do |x|


.map could also be used here to give you an array of Channel instances

dev-elle-up and others added 20 commits March 19, 2019 14:06

Added .env to .gitignore.

228aa80

completes wave 1 but without class structure yet

731b4ae

completes coding requirements for wave 1 and adds a slack class

fa070bb

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

b45546e

Updated the test file to require dotenv and to set up VCR.configure.

8089c88

Set up tests for list channels. Addressed some bugs with linking file…

1b667e5

…s together (require statements) and circular reference with minitest.

some small changes from lecture

474d458

adds wave 2 functionalities, and splits methods into different classes

04b715a

Wrote and stemmed out more tests for selecting channels and users.

99e66c3

Wrote and stemmed out more tests for selecting channels and users.

e1e3ec6

Added tests for selecting users and channels. Currently not working.

18e25dc

changes the format of some of the test files to match class structure

87f5a28

merges better

92be44b

fixes bug with downcase, better matching for selection methods

ca1b2fc

stopping point for Friday

4767ec0

fixes send message and comepletes wave 3

d8a3ca1

Cleaned up user interface. Fixed 'show details when no user/channel i…

22b9e57

…s selected' to not throw an error and crash. Worked on making 'send message' work on my machine; not done.

Fixed the 'send_msg' method. Can now send a message to a channel.

c3a8892

Removed unnecessary comments in spec file and tests that were unused …

f778e37

…due to refactoring or being duplicates.

CheezItMan reviewed Mar 31, 2019

View reviewed changes

CheezItMan reviewed Apr 2, 2019

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ports - Kasey and Elle #15

Ports - Kasey and Elle #15

dev-elle-up commented Mar 22, 2019 •

edited

Loading

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

CheezItMan Mar 31, 2019

CheezItMan Apr 2, 2019

Ports - Kasey and Elle #15

Are you sure you want to change the base?

Ports - Kasey and Elle #15

Conversation

dev-elle-up commented Mar 22, 2019 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dev-elle-up commented Mar 22, 2019 •

edited

Loading