Add support for Slack's "Blocks" and OAuth instead of webhooks by mikeymclellan · Pull Request #53 · nexylan/slack

mikeymclellan · 2019-07-30T04:42:29Z

No description provided.

…king backwards compatibility

soullivaneuh

Hi and thanks for your contribution!

Can you please give a documentation link explaining the deprecated stuff and how to migrate?

soullivaneuh · 2019-08-01T08:16:55Z

README.md

+
+```php
+$message = $this->slackClient->createMessage()
+            ->setText('This is the fallback text')


Too much indentation here.

I've updated this

soullivaneuh · 2019-08-01T08:24:22Z

src/Client.php

+        return $this;
+    }
+
+    public function setOptions(array $options, string $endpoint = self::SLACK_POST_MESSAGE_URL, HttpClient $httpClient = null): self


Could you please explain why you created a setOptions method? I don't see the interest as the options can be defined on the constructor.

It's a bit of a balancing act trying to not break backward-compatibility.

Slack has deprecated webhook endpoints so ideally endpoint would just be an option with a sensible default. But unfortunately, the constructor has it as the first parameter.

The two ways I see this being called are the old web-hook way:

$client = new Nexy\Slack\Client('https://hooks.slack.com/...', $options);

And the new oauth way:

$client = (new Nexy\Slack\Client())->setOptions($options);

I guess I could get rid of the setOptions function and then people would have to instantiate like this:

$client = new Nexy\Slack\Client(Nexy\Slack\Client::SLACK_POST_MESSAGE_URL, $options);

But I kinda thought that was a little yuck.

soullivaneuh · 2019-08-01T08:24:31Z

src/Client.php

+    {
+        $this->options = $this->optionsResolver->resolve($options);
+        $this->setEndpoint($endpoint, $httpClient);
+        return $this;


I don't think we need this.

soullivaneuh · 2019-08-01T08:25:09Z

src/Client.php

 */
 final class Client
 {
+    const SLACK_POST_MESSAGE_URL = 'https://slack.com/api/chat.postMessage';


So the API structure is the same as web-hook but with a common URL now, am I right?

soullivaneuh · 2019-08-01T08:25:46Z

src/Client.php

                'unfurl_media' => true,
                'allow_markdown' => true,
                'markdown_in_attachments' => [],
+                'oauth_token' => null


token should be enough.

I prefer oauth_token as it matches what it's called in the Slack documentation and interface, and there are many other types of tokens available in Slack:

OAuth Access Token

Bot User OAuth Access Token

Verification Token

And also

App ID

Client ID

Client Secret

Signing Secret

soullivaneuh · 2019-08-01T08:26:58Z

src/Client.php

            ->setAllowedTypes('unfurl_media', 'bool')
            ->setAllowedTypes('allow_markdown', 'bool')
            ->setAllowedTypes('markdown_in_attachments', 'array')
+            ->setAllowedTypes('oauth_token', ['string', 'null'])


Should be mandatory. Maybe it can be set on the constructor instead to be an option.

It's not mandatory so as to not break backward compatibility.

soullivaneuh · 2019-08-01T08:27:34Z

README.md


 ### Instantiate the client

+Using Slack's [OAuth token](https://api.slack.com/messaging/sending) method:


The link does not seem to show oauth usage directly.

I've updated this.

RafaelFerreiraTVD · 2019-08-01T12:04:33Z

src/Block.php

+     */
+    private $blockId;
+
+    public function __construct(?string $type)


Missing PHPDoc

Not necessary, the strict typing is enough.

Except if you want to add detail about $type description.

soullivaneuh · 2019-08-01T12:19:05Z

Also, can we please have some tests about the new introduced feature?

mikeymclellan · 2019-08-01T20:43:59Z

Re. backward compatibility. I was thinking these changes could be released as a minor version change, then then I could tidy up the constructor signature to something more sensible as a breaking change in a new major version change.

mikeymclellan · 2019-08-01T21:30:32Z

Also, can we please have some tests about the new introduced feature?

I'll try and find some motivation for writing tests, but..... it's not my strength ;)

soullivaneuh · 2019-08-02T08:22:17Z

Hi @mikeymclellan,

The next release will be a major one, so don't worry about BC break.

But you may update the UPGRADE note I just added.

Thanks

soullivaneuh · 2019-11-25T09:08:27Z

@mikeymclellan bump ! :-)

Do you have some time to finish this merge request?

Otherwise, could you please give me edit access?

mikeymclellan · 2021-02-03T03:02:32Z

Sorry for the VERY slow reply @soullivaneuh 😊

I've granted you access now.

mikeymclellan added 5 commits July 30, 2019 08:49

Add support for Slack Blocks in messages

be09b3a

Add support for Slack Blocks in messages

d63d167

Add ability to set slack's replace_original field

c63b127

Add OAuth support for sending messages

2bbc0e2

Add some docs for using OAuth and simplify the interface without brea…

167fcfb

…king backwards compatibility

soullivaneuh suggested changes Aug 1, 2019

View reviewed changes

RafaelFerreiraTVD reviewed Aug 1, 2019

View reviewed changes

mikeymclellan added 4 commits August 2, 2019 08:47

Fix doc indentation

48ff124

Update Slack Oauth documentation link

1e1d4c7

Update documentation intro to include oauth info

505570c

Remove company logo etc

a0d0339


		### Instantiate the client

		Using Slack's [OAuth token](https://api.slack.com/messaging/sending) method:

Conversation

mikeymclellan commented Jul 30, 2019

Uh oh!

soullivaneuh left a comment

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!

mikeymclellan Aug 1, 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!

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!

soullivaneuh commented Aug 1, 2019

Uh oh!

mikeymclellan commented Aug 1, 2019

Uh oh!

mikeymclellan commented Aug 1, 2019

Uh oh!

soullivaneuh commented Aug 2, 2019

Uh oh!

soullivaneuh commented Nov 25, 2019

Uh oh!

mikeymclellan commented Feb 3, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mikeymclellan Aug 1, 2019 •

edited

Loading