Ports - Angela and Shamira by MiraMarshall · Pull Request #3 · Ada-C11/slack-cli

MiraMarshall · 2019-03-22T17:51:36Z

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 explored the Slack API through postman. Postman will be useful in future projects involving APIs.
Give a short summary of the request/response cycle. Where does your program fit into that scheme?	With our User and Channel classes we send a GET request to the Slack API. With our Recipient Class we use a POST request to the Slack API and include payload with headers and a body hash. The API returns a response as JSON with the requested information.
How does your program check for and handle errors when using the Slack API?	We created a custom SlackApiError message that inherits from the standard error message. We raise an error if the input does not include a valid user or channel. We also raise our SlackApiError when we get a false response from the Slack API.
Did you need to make any changes to the design work we did in class? If so, what were they?	Our starting classes were User, Channel, and Recipient, which was in line with our original design. After working on those classes we decided to implement a Workspace class more in line with the given design from the instructors.
Did you use any of the inheritance idioms we've talked about in class? How?	The only inheritance we used was the SlackApiError that inherited from the standard error message.
How does VCR aid in testing a program that uses an API?	VCR allows us to test our requests to the API with fewer calls by recording cassettes that allow us to test the code multiple times even if the API is down or we are offline.

…equirements

… error.

CheezItMan · 2019-03-31T19:34:25Z

slack.rb

What We're Looking For

Feature	Feedback
Core Requirements
Git hygiene (no slack tokens)	Good commit messages, no slack token!
Comprehension questions	Check
Functionality
List users/channels	Check
Select user/channel	Check
Show details	Check, but it doesn't label the fields returned, so a little bare bones.
Send message	Check
Program runs without crashing	If I enter a misspelled command the app seems to get stuck in a loop and I have to ^C to exit the app.
Implementation
API errors are handled appropriately	Nope, if I select a user who doesn't exist, I get no error. Then if I send them a message the app crashes! Ditto with channel! Showing details doesn't generate an error or even a notice things went wrong.
Inheritance model matches in-class activity	Nope
Inheritance idioms (abstract class, template methods, polymorphism) used appropriately	No Inheritance or polymorphism, or much composition. The design is more than a little awkward.
Methods are used to break work down into simpler tasks	For the most part, see your method to send a message for a method that's not broken down well.
Class and instance methods are used appropriately	You are overusing class methods here. You really should have designed User and Channel as classes that you can make instances of.
Overall	You hit most of the learning goals for the project, but your design is awkward. You are not taking advantage of duck typing or polymorphism. For example if you have User or Channel instances that both have `details` and `send_message` methods you can just call them on the currently selected item and it doesn't matter if it's a channel or user. Take a look at the instructor reference design and read my inline comments. Let me know any questions you have.

CheezItMan · 2019-03-31T19:16:25Z

lib/channel.rb

+require "pry"
+Dotenv.load
+
+class Channel


This class is just one class method. Instead I suggest having a Channel class with instance variables and methods. Your list method could then return an array of Channel instances.

CheezItMan · 2019-03-31T19:16:52Z

lib/dont_use_recipient.rb

@@ -0,0 +1,62 @@
+require "httparty"


Looks like you got started on this but didn't get finished. I suggest removing it from git.

CheezItMan · 2019-03-31T19:20:57Z

lib/recipient.rb

+
+    #### TODO: CHANGE VARIABLE NAME
+    practice = []
+    User.list.each do |user_name_list|


Here you end up making the same API call multiple times, this is inefficient. It might be much more useful to have list create an array of User instances with usernames, ids etc.

CheezItMan · 2019-03-31T19:21:43Z

lib/recipient.rb

+      end
+    end
+
+    test_workspace = Workspace.new


Why do you create a Workspace in this Recipient class.

CheezItMan · 2019-03-31T19:23:19Z

lib/recipient.rb

+    end
+
+    test_workspace = Workspace.new
+    if channel_name.include?(user)


This if-elsif block is a little awkward and could be made much cleaner with duck typing for the User and Channel classes.

CheezItMan · 2019-03-31T19:25:28Z

lib/workspace.rb

+  class SlackApiError < StandardError; end
+
+  def select_channel(selected)
+    selected


What is the purpose of this method? It takes an argument and just returns the argument?

CheezItMan · 2019-03-31T19:26:33Z

practice.rb

+puts "4. Select Channel"
+puts "5. Quit"
+
+selection = gets.chomp


If this file isn't in your submission, please don't include it in the PR.

CheezItMan · 2019-03-31T19:27:40Z

specs/channel_spec.rb

+    VCR.use_cassette("slack_channels") do
+      Channel.new
+
+      expect(Channel.list[0][0]).must_equal "everyone"


You can't always assume that the API will always return things in the same order. I would probably write the test to check to see if the array includes "everyone" instead.

CheezItMan · 2019-03-31T19:28:04Z

specs/recipient_spec.rb

+    end
+  end
+
+  it "will raise an error if given an empty message" do


CheezItMan · 2019-03-31T19:28:45Z

specs/user_spec.rb

+
+  it "lists correct username" do
+    VCR.use_cassette("slack_users") do
+      User.new


Since you are using class methods you don't need to make an instance of User.

MiraMarshall and others added 28 commits March 19, 2019 11:26

Class setup

ebfcdff

set up Channel class

c8a83ff

added structure for recipient and workspace classes

7fbfc4e

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

4a0c8c4

finializing class structure

62d357d

created self.list method in User class and corresponding passed tests.

f319692

added self.list

fdc8b53

added list method for channel class and tests

b269ec9

created main method in Slack.rb file

c9c7242

added workspace class and tests

f1851b1

added test for show_details_user method

821a745

added driver code to slack.rb

ba5104d

added slack_api_wrapper class and spec

c732249

deleted extra files and added additional option for main class

c555943

added until loop in slack.rb

6947a93

added useful comment

112a72f

adding details functionality

b8bb13d

fixed show_details

3365cec

notes on how to add select methods to send user method

9bc79b5

fixed sending message to a channel

c2551d7

fixed our ability to send messages to user and aligned with project r…

e3c6412

…equirements

fixed sending message to user

49c24cd

Added tests for workspace

4a81dcb

cleaned up comments

955e8b1

added better formatting for options in slack.rb

fd84b3b

we DRY'd our code and changed Argument Error to custom error

777140e

erase unneccesary constructor and changed ArgumentError to our custom…

dbbfdac

… error.

added tests for recipient-channel and workspace-channel

43a8e26

CheezItMan reviewed Mar 31, 2019

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ports - Angela and Shamira#3

Ports - Angela and Shamira#3
MiraMarshall wants to merge 28 commits intoAda-C11:masterfrom
MiraMarshall:master

MiraMarshall 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

Uh oh!

CheezItMan Mar 31, 2019

Uh oh!

CheezItMan Mar 31, 2019

Uh oh!

CheezItMan Mar 31, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

MiraMarshall commented Mar 22, 2019

slack.rb

Comprehension Questions

Uh oh!

CheezItMan commented Mar 31, 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!

3 participants