Feature/emoticon downloader #48

0verbyte · 2018-02-04T03:23:01Z

Converts emoticon download script to an actual command that can be ran in REPL.

Command usage text:

0xCoders> emojis -h
usage: emoji.list [-h] [-p PATH] [-q]

Lists custom emojis in workspace

optional arguments:
  -h, --help            show this help message and exit
  -p PATH, --path PATH  Local file path where to save emojis to
  -q, --quiet           Don't print response from Slack API

netromdk

Great that you ported it as a command. I just have a few comments.

netromdk · 2018-02-04T09:36:35Z

slacker/commands/emoji_list_command.py

+    self.logger.debug('Writing to disk {}({}) -> {}'.format(url, content_length, self.local_save_path))
+    with open(local_save_path, 'wb') as f:
+      for chunk in res.iter_content(1024):
+        f.write(chunk)


We should probably implement a Downloader class of some kind, or add to slacker.utility, at some point to encapsulate this function's functionality so it can be reused for other stuff.

Agreed. I think we need to extend the project to have useful utility functions

netromdk · 2018-02-04T09:41:23Z

slacker/commands/emoji_list_command.py

+
+    for emoji in emojis:
+      emoji_url = emojis[emoji]
+      if emoji_url[:5] == 'alias':


You can use emoji_url.startswith('alias') for readability and to be sure 5 doesn't stay unchanged if the word "alias" does, for instance.

netromdk · 2018-02-04T09:43:18Z

slacker/commands/emoji_list_command.py

+        continue
+
+      saved_file_path = self.__download_emoji(emoji, emojis[emoji])
+      save_data[emoji] = saved_file_path


A nice-to-have for later would be a concurrent download of all emojis to speed things up.

I agree. I will add a task for this

netromdk · 2018-02-04T09:44:02Z

slacker/commands/emoji_list_command.py

+
+    res = requests.get(url, stream=True)
+    if res.status_code != 200:
+      self.logger.warning('Unable to download {}: {}'.format(emoji_name, url))


We probably need to support HTTP redirects (3xx).

Ah, nevermind. I just found that follow_redirects = True per default: http://docs.python-requests.org/en/master/user/quickstart/#redirection-and-history

netromdk · 2018-02-04T09:46:00Z

slacker/commands/emoji_list_command.py

+
+  def __write_save_file(self, save_data):
+    with open(self.save_data_file, 'w') as f:
+      f.write(json.dumps(save_data, indent=2))


Any reason you don't do json.dump(save_data, f, indent = 2)?

netromdk · 2018-02-04T09:51:33Z

slacker/commands/emoji_list_command.py

+    self.logger.info('Contacting Slack API for emojis')
+
+    slack_api = SlackAPI()
+    emojis = slack_api.post('emoji.list')['emoji']


I like to check the 'ok' in responses to see if things went as they should, and to print the 'error' if it did not.

Perhaps SlackAPI.post should return an object so we can do something like this:

slack_api = SlackAPI() resp = slack_api.post('emoji.list') if not resp.ok(): self.logger.error(resp.error()) emojis = resp.json['emoji']

It would be great to make it easy to check for success. Another way would be for SlackAPI to simply throw an exception if not "ok" and an error is defined?

We can create a task for extending the SlackAPI class to handle network errors. Another case of failure would be when the API returns malformed JSON in rare cases, that would cause an exception to be thrown and we aren't catching it.

netromdk · 2018-02-04T09:53:15Z

slacker/commands/emoji_list_command.py

+    slack_api = SlackAPI()
+    emojis = slack_api.post('emoji.list')['emoji']
+
+    if args.quiet == False:


You could also write if not args.quiet:

netromdk · 2018-02-04T09:54:31Z

slacker/commands/emoji_list_command.py

+    if args.quiet == False:
+      self.print_emojis(emojis)
+
+    if args.path is not None:


if args.path: is a little shorter.

netromdk · 2018-02-04T10:12:09Z

slacker/commands/emoji_list_command.py

+
+    self.logger.info('Emoji image files saved to {}'.format(self.local_save_path))
+    cwd_save_data = os.path.join(os.getcwd(), self.save_data_file)
+    self.logger.info('Emoji save data file saved to {}'.format(cwd_save_data))


Shouldn't the JSON file be saved to where --path points to if defined?

I thought about it, but it is nice that it is saved relative to where you run slacker. The save data file also includes the path to where the emoji was downloaded. Perhaps later we can create a command to do something with the emoji once they've been downloaded, like import to another workspace or something? Unfortunately Slack doesn't provide methods for creating custom emojis yet, so not sure what to do once downloaded :/

{ "bowtie": "/tmp/bowtie.png", "squirrel": "/tmp/squirrel.png", "glitch_crab": "/tmp/glitch_crab.png", "piggy": "/tmp/piggy.png", "cubimal_chick": "/tmp/cubimal_chick.png", "dusty_stick": "/tmp/dusty_stick.png", "slack": "/tmp/slack.png", "pride": "/tmp/pride.png", "thumbsup_all": "/tmp/thumbsup_all.gif", "slack_call": "/tmp/slack_call.png", "shipit": "alias:squirrel", "white_square": "alias:white_large_square", "black_square": "alias:black_large_square", "simple_smile": "/tmp/simple_smile.png", "metal": "/tmp/metal.png" }

That's a good point. Let's keep it as-is for now. It's a little annoying we can't import via their API, yes. :/ But I still think it's useful because it is then easier to add manually to another workspace.

0verbyte · 2018-02-04T17:25:49Z

@netromdk updated

netromdk

Very good. I'll merge.

0verbyte assigned netromdk Feb 4, 2018

netromdk reviewed Feb 4, 2018

View reviewed changes

0verbyte added 2 commits February 4, 2018 09:23

Add command for download workspace custom emoticons

d74a6fb

Delete scripts directory since they've been converted to commands

c5f46d4

0verbyte force-pushed the feature/emoticon-downloader branch from 387122f to c5f46d4 Compare February 4, 2018 17:23

netromdk approved these changes Feb 4, 2018

View reviewed changes

netromdk merged commit af3b752 into master Feb 4, 2018

netromdk deleted the feature/emoticon-downloader branch February 4, 2018 17:54

netromdk mentioned this pull request Feb 4, 2018

Emoticon download #1

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/emoticon downloader #48

Feature/emoticon downloader #48

0verbyte commented Feb 4, 2018

netromdk left a comment

netromdk Feb 4, 2018

0verbyte Feb 4, 2018

0verbyte Feb 4, 2018 •

edited

Loading

netromdk Feb 4, 2018

netromdk Feb 4, 2018

0verbyte Feb 4, 2018

0verbyte Feb 4, 2018

netromdk Feb 4, 2018

netromdk Feb 4, 2018

netromdk Feb 4, 2018

netromdk Feb 4, 2018

0verbyte Feb 4, 2018

0verbyte Feb 4, 2018

netromdk Feb 4, 2018

netromdk Feb 4, 2018

netromdk Feb 4, 2018

0verbyte Feb 4, 2018 •

edited

Loading

netromdk Feb 4, 2018

0verbyte commented Feb 4, 2018

netromdk left a comment

Feature/emoticon downloader #48

Feature/emoticon downloader #48

Conversation

0verbyte commented Feb 4, 2018

netromdk left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0verbyte Feb 4, 2018 • edited Loading

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

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

0verbyte Feb 4, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0verbyte commented Feb 4, 2018

netromdk left a comment

Choose a reason for hiding this comment

0verbyte Feb 4, 2018 •

edited

Loading

0verbyte Feb 4, 2018 •

edited

Loading