Sockets - Tati Hana #20

hanalways · 2019-03-22T23:47:10Z

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 first tackled the documentation through Slack for each of the three different URIs. After thoroughly understanding the requirements and parameters for each of the APIs, we explored POST by establishing our recipient class (post_message method) before GET (self.get method). Postman also aided in our understanding of APIs and helped cement the difference between URI, tokens, query parameters, body and header. Reading the documentation provided will definitely be something that will be carried over for every future project concerning APIs.
Give a short summary of the request/response cycle. Where does your program fit into that scheme?	The request/response cycle starts with a user taking an action where the client sends the request. The server processes this request and sends a response where the client displays that response to the user. Our User and Channel classes inherit the Recipient class where they send a GET and POST request which includes payloads. The API returns a response as a JSON with the requested parameters.
How does your program check for and handle errors when using the Slack API?	Our program responds to any errors by raising a custom SlackError message that inherits from StandardError class. We raise this error anytime we do not get a 200 OK response code, or if we return a JSON value false for “ok”, such as having a bad URI or token. We also raise this error if user invokes details when there is no channel or user previously selected, or when sending a message that’s nil or blank.
Did you need to make any changes to the design work we did in class? If so, what were they?	We changed the parameters that were passed for certain methods such as self.get and send_message.
Did you use any of the inheritance idioms we've talked about in class? How?	Our Recipient class is an abstract class as it only serves as a parent class of User and Channel (concrete classes). Our workspace class is also an example of concrete classes as it is instantiated in our main driver code. Our self.get and send_message methods are examples of template methods as they are overriden in User and Channel. We’ve used polymorphism when invoking send_message and show_details methods of our workspace on either User or Channel, thus making our Workspace an interface.
How does VCR aid in testing a program that uses an API?	VCR aids in testing a program by recording each API response as a cassette and can replay them when you need to test your methods, thus improving stability and performance.

…tested in subclasses

droberts-sea · 2019-03-30T04:27:28Z

slack.rb

What We're Looking For

Feature	Feedback
Core Requirements
Git hygiene (no slack tokens)	yes
Comprehension questions	yes
Functionality
List users/channels	yes
Select user/channel	yes
Show details	yes
Send message	yes
Program runs without crashing	yes
Implementation
API errors are handled appropriately	yes
Inheritance model matches in-class activity	yes
Inheritance idioms (abstract class, template methods, polymorphism) used appropriately	yes
Methods are used to break work down into simpler tasks	yes
Class and instance methods are used appropriately	yes
Overall	Great job overall! This code is clean, well-organized and mostly well-tested, and it's clear to me that the learning goals around understanding the request/response cycle, interacting with an API and implementing a design from scratch using inheritance were met. I've left a few inline comments, but in general I like what I see. Keep up the hard work!

droberts-sea · 2019-03-30T04:13:05Z

lib/recipient.rb

+
+    def self.list_url
+      raise NotImplementedError, "TODO: implement me in a child class"
+    end


This is a great use of a template method.

droberts-sea · 2019-03-30T04:15:59Z

lib/recipient.rb

+    # :nocov:
+    def details
+      raise NotImplementedError "TODO: implement me in a child class"
+    end


Instead of excluding this from coverage, why not have a test that Recipient by itself without a subclass will raise this exception when this method is called?

droberts-sea · 2019-03-30T04:20:45Z

lib/slack.rb

+        workspace.send_message(message)
+        # rescue SlackCli::SlackError
+        puts "No user or channel selected, try again"
+        # end


This error message always prints out, even if the send is successful. Instead, you should check the result and give the user positive or negative feedback.

droberts-sea · 2019-03-30T04:21:25Z

lib/workspace.rb

+  def select_user(name)
+    @selected = @users.find do |user|
+      user.name == name || user.slack_id == name
+    end


Good use of the .find enumerable here.

droberts-sea · 2019-03-30T04:22:13Z

lib/workspace.rb

+    if @selected == nil 
+      puts "That user does not exist" 
+    else
+      return @selected


Since this code is here to interact with the user, I would probably consider it view code and move it to the main method.

droberts-sea · 2019-03-30T04:24:09Z

specs/channel_spec.rb

+  describe "details" do
+    it "lists details for an instance of Channel" do
+      channel = channel_list[1]
+


What happens if you create a Channel manually with bogus data and then call .details on it?

channel = SlackCli::Channel.new('bad_id', 'channel_dne', '', 0) channel.details

Presumably this would work just fine, but it makes an interesting test case.

droberts-sea · 2019-03-30T04:25:48Z

specs/workspace_spec.rb

+    it "returns nil if no channel selected" do
+      assert_nil(workspace.select_channel(""))
+      assert_nil(workspace.select_channel(nil))
+    end


I like that you're testing these failure cases. What happens to a previously selected user/channel in this case?

tatsqui and others added 30 commits March 18, 2019 17:17

added .env and did verification

b7f136a

removed comment

3eb6a7c

creating necessary class files

af9d38f

configuring test_helper.rb

e0c01e4

debugging test_helper

b8ef5d2

set up test spec files

8d2236b

initialize and create send message method

268e8a7

require dotenv

33024d0

debugging bad token and string escape characters may be needed

daed6bd

added kwards to #send_message

d35b5ea

#correction .send_message

8095052

wrote tests for .send_message and tests are green

531e18f

self.get method and test

3688e72

SlackError for bad parameters test

9c3d836

SlackError for inauthorization

4dc98b3

added details and self.list

0ac44df

create and move constants to respective classes

fd2d0c9

"adding channel class"

637be8c

working on self.list channel.rb

a3fc48c

refactor self.get and define constants

6a2a7c8

added .list and #details

0f4cff0

move constants and refactor self.get

c55c990

moved constants updated self.get tests

a7c294e

update self.list and self.list_users methods

b5ff318

"adding tests to channel_spec"

489063b

"first test passed in channel_spec"

b31c6e7

updating self.list in Channel

85cc32e

added #details in channel class

45f1f1b

added details and updated list to reference correct values

bca0e4d

wrote nominal tests for channel_spec

963e0a9

tatsqui and others added 28 commits March 20, 2019 17:50

DRYed up channel/user and workspace

a88b86d

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

e7ccce6

list_channels and list_users methods

79412b7

working logic for select, bug for send_message

c981d71

refactor send_message method and write some tests

e31cace

moved driver code into slack.rb

b230f92

commented out tests for superclass Recipient

6b0725b

miscellaneous changes in channel and user specs

1d12a37

changed #details to return variable in method

624b2b4

making tests in user and channel specs more congruent

0f95b07

added more selected_user/channel validation tests

1a18c7d

details method updated with error

54b43c0

"working out #details exception"

64d648f

merge

3e80151

trying out tri-error block

1bba049

rescue details when selected nil

4de5188

added real error message

6b7fd8e

"writing edge case tests for workspace"

bf211e2

additional tests for coverage

0f93205

"made .error_helper a class method"

53788e2

list_url template method, moved some tests into recipient

a33963f

"merging files"

2456ebc

added missing end workspace.rb

de4fa52

added missing ends in workspace_spec

bfcc4d5

"editing style"

1d9024e

hid view from simplecov, and some methods in Recipient that are only …

df3c9f4

…tested in subclasses

added checking for when the select_channel or user does not exist

9097e75

"added one more test for selecting nil user"

640e673

droberts-sea reviewed Mar 30, 2019

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sockets - Tati Hana #20

Sockets - Tati Hana #20

hanalways commented Mar 22, 2019

droberts-sea commented Mar 30, 2019

droberts-sea Mar 30, 2019

droberts-sea Mar 30, 2019

droberts-sea Mar 30, 2019

droberts-sea Mar 30, 2019

droberts-sea Mar 30, 2019

droberts-sea Mar 30, 2019

droberts-sea Mar 30, 2019

Sockets - Tati Hana #20

Are you sure you want to change the base?

Sockets - Tati Hana #20

Conversation

hanalways commented Mar 22, 2019

slack.rb

Comprehension Questions

droberts-sea commented Mar 30, 2019

slack.rb

What We're Looking For

droberts-sea Mar 30, 2019

Choose a reason for hiding this comment

droberts-sea Mar 30, 2019

Choose a reason for hiding this comment

droberts-sea Mar 30, 2019

Choose a reason for hiding this comment

droberts-sea Mar 30, 2019

Choose a reason for hiding this comment

droberts-sea Mar 30, 2019

Choose a reason for hiding this comment

droberts-sea Mar 30, 2019

Choose a reason for hiding this comment

droberts-sea Mar 30, 2019

Choose a reason for hiding this comment