slack-big-emoji 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d717723d6be71d5d01fc84d5957a22623b38a294
+  data.tar.gz: 26f432aa79813c94aff58a0837b5372c241e1dbd
+SHA512:
+  metadata.gz: 5ebd90f25594fde8ccca402428694a5afc0b998091f079796e0513975ad82b0059a366c3a45f5c2bd318ce4ddb7fa63ef8a8b99ef47f4c7b157fcf749c5592a1
+  data.tar.gz: c8b8694b7f4c452ae867581394dc4b6ffd15801ed0029eda150c80276e7bb3ed3bd6108b0de2d549056017867ddf78351181b11c5b8d1b8d6f337f23d0725cbe

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rbenv-gemsets

@@ -0,0 +1 @@
+slack-big-emoji

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Alejandro AR
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,115 @@
+# Slack Big Emoji
+
+Slack Big Emoji is a ruby command-line tool (see support) that helps out with the generation of big emojis to a Slack team.
+
+See [What's a Big Emoji?](#whats-a-big-emoji) for more information.
+
+## Support
+
+Make sure you're using Ruby 2.4.0 (will support native OS X version soon) and you have a working installation of ImageMagick.
+
+About images:
+
+- Tool can only process static image files (only png, jpg, jpeg).
+- Images must be square or hold a w/h ratio of 1.0, this is going to be validated.
+- No GIF support since Slack's limit is 64kb and it's a pain to generalize optimization.
+
+## Installation
+
+Installation is done through RubyGems, to install run:
+
+```
+$ gem install slack-big-emoji
+```
+
+Once completed you should be ready to go.
+
+## Usage
+
+First, locate a square image and run:
+
+```
+$ slack-big-emoji liarliar.jpg
+```
+
+The script will resize and crop the image into tiles and upload them all (through a small wizard) to your team's Slack.
+
+You can also run `slack-big-emoji --help` for more options.
+
+
+## What's a Big Emoji?
+
+Big emojis are a set of multiple emojis combined in a grid that together displays a big image.
+
+
+> — Probably you: What?
+>
+> — Me, probably: Why not?
+>
+> — You: I mean, what's a Slack Big Emoji?
+
+A Bigger Emoji™.
+
+With this tool you'll be able to turn this Jim Carrey snapshot from the movie Liar Liar:
+
+![Picture of Jim Carrey's teeth in the movie "Liar Liar"](https://user-images.githubusercontent.com/1270156/27774411-73333d40-5f57-11e7-933e-751dbc178617.jpg)
+
+Into a set of emoji codes like this one:
+
+```
+:liarliar00::liarliar01::liarliar02::liarliar03::liarliar04:
+:liarliar05::liarliar06::liarliar07::liarliar08::liarliar09:
+:liarliar10::liarliar11::liarliar12::liarliar13::liarliar14:
+:liarliar15::liarliar16::liarliar17::liarliar18::liarliar19:
+:liarliar20::liarliar21::liarliar22::liarliar23::liarliar24:
+```
+
+Once posted in Slack will look like this (mobile looks shitty, tho):
+
+![](https://user-images.githubusercontent.com/1270156/27774488-935d2850-5f58-11e7-8417-944b1251a3da.png)
+
+## Advanced Installation & Usage
+
+This gem can be used from an application too, add this line to your Gemfile:
+
+```ruby
+gem 'slack-big-emoji'
+```
+
+And then execute:
+
+```ruby
+$ bundle install
+```
+
+For example, this is the minimal setup for a command-line tool:
+
+```ruby
+require 'slack-big-emoji'
+# require 'slack-big-emoji/cli'
+
+# Sets up option parser coming from ARGV
+cli = SlackBigEmoji::CLI.new(ARGV)
+
+# Converter takes as args the file and conversion options
+emoji = SlackBigEmoji::Converter.new(cli.options)
+emoji.convert
+
+# The uploader takes care to upload a folder full of images
+uploader = SlackBigEmoji::Uploader.new(emoji.output_filename)
+uploader.upload_emojis
+
+# The CLI generates a grid based on the output filename,
+# this is the grid to be used in Slack to see the full emoji
+cli.emoji_grid(emoji.output_filename)
+```
+
+Further documentation can be read in code.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kinduff/slack-big-emoji. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-cayman

data/bin/slack-big-emoji

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+require_relative '../lib/slack_big_emoji'
+
+cli = SlackBigEmoji::CLI.new(ARGV)
+emoji = SlackBigEmoji::Converter.new(cli.options)
+unless emoji.valid?
+  abort "Image must be a square, w/h ratio of 1.0"
+end
+
+cli.log "File Info"
+cli.log "--------------"
+cli.log "File name", emoji.file_name
+cli.log "Ratio", emoji.ratio
+cli.log "File Resize Spec", emoji.file_resize_spec
+cli.log ""
+cli.log "Options"
+cli.log "--------------"
+cli.log "Tile Width", emoji.tile_width
+cli.log "Crop Size", emoji.crop_size
+cli.log ""
+cli.log "CLI Options"
+cli.log "--------------"
+cli.options.each do |option, value|
+  cli.log "#{option}", value
+end
+
+cli.log ""
+cli.log "Converting"
+cli.log "--------------"
+cli.log "Temp Input", emoji.image.path
+cli.log "Output Dir", emoji.output_dir
+cli.log "Output Path", emoji.output_path
+emoji.convert
+cli.log "Done", "Yes"
+
+unless cli.options[:convert_only]
+  cli.log ""
+  cli.log "Uploading"
+  cli.log "--------------"
+  uploader = SlackBigEmoji::Uploader.new(emoji.file_name)
+  uploader.upload_emojis
+end
+
+cli.log ""
+cli.log "Emoji Grid"
+cli.log "--------------"
+cli.emoji_grid(emoji.output_filename)

data/lib/slack_big_emoji.rb

@@ -0,0 +1,6 @@
+module SlackBigEmoji
+  require 'slack_big_emoji/version'
+  require 'slack_big_emoji/cli'
+  require 'slack_big_emoji/converter'
+  require 'slack_big_emoji/uploader'
+end

data/lib/slack_big_emoji/cli.rb

@@ -0,0 +1,73 @@
+require 'optparse'
+
+module SlackBigEmoji
+  class CLI
+    attr_accessor :options
+
+    def initialize(args)
+      @options = parse(args)
+    end
+
+    def parse(args)
+      options = {}
+      opts = OptionParser.new do |opts|
+        opts.banner = "Usage: slack-big-emoji [options] FILE"
+        opts.version = SlackBigEmoji::VERSION
+
+        opts.on( '-f', '--file-name=NAME', 'Output filename.' ) do |val|
+          options[:output_filename] = val
+        end
+
+        opts.on( '-o', '--output-dir=NAME', 'Output directory.' ) do |val|
+          options[:output_dir] = val
+        end
+
+        options[:silent] = false
+        opts.on( '-s', '--silent', 'Silent or quiet mode.' ) do
+          options[:silent] = true
+        end
+
+        options[:convert_only] = false
+        opts.on( '-c', '--convert-only', 'Convert image but do not upload.' ) do
+          options[:convert_only] = true
+        end
+
+        opts.on_tail( '-h', '--help', 'Show this message' ) do
+          puts opts
+          exit
+        end
+      end
+      opts.parse! # removes switches destructively, but not non-options
+
+
+      file = args.first # ARGV args only - no options
+
+      # validates input to be one image file, no gif support (yet)
+      abort "Error: Missing input file" unless file
+      abort "Just specify one file" if args.count > 1
+      abort "Use a valid image file (png, jpeg or jpg)" if (file =~ /.\.(png|jpeg|jpg)$/).nil?
+
+      options[:file] = file
+
+      options
+    end
+
+    def emoji_grid(file_name)
+      25.times do |i|
+        puts "" if i % 5 == 0 && i != 0
+        print ":#{file_name}#{("%02d" % i)}:"
+      end
+      puts # madrs
+    end
+
+    def log(*msg)
+      unless @options[:silent]
+        if msg.size == 1
+          puts msg
+        else
+          printf "%-20s %s\n", msg.first, msg.last
+        end
+      end
+    end
+  end
+end

data/lib/slack_big_emoji/converter.rb

@@ -0,0 +1,34 @@
+require 'mini_magick'
+require_relative 'uploader'
+
+module SlackBigEmoji
+  class Converter
+    attr_accessor :image, :file_name, :ratio, :file_resize_spec, :tile_width, :crop_size, :output_dir, :output_filename, :output_path
+
+    def initialize(options={})
+      @image = ::MiniMagick::Image.open(options[:file])
+      @file_name = File.basename(options[:file], ".*")
+      @ratio = @image[:width].to_f/@image[:height].to_f
+      @file_resize_spec = '640x640'
+      @tile_width = 5
+      @crop_size = '128x128'
+      @output_dir = options[:output_dir] || @file_name
+      @output_filename = options[:output_filename] || @file_name
+      @output_path = "#{@output_dir}/#{@output_filename}%02d.png"
+    end
+
+    def valid?
+      return @ratio == 1
+    end
+
+    def convert
+      convert_opts = ["-resize", @file_resize_spec, "-crop", @crop_size]
+      Dir.mkdir(@output_dir) unless File.exists?(@output_dir)
+      ::MiniMagick::Tool::Convert.new do |convert|
+        convert << @image.path
+        convert.merge! convert_opts
+        convert << @output_path
+      end
+    end
+  end
+end

data/lib/slack_big_emoji/uploader.rb

@@ -0,0 +1,71 @@
+require 'highline/import'
+require 'mechanize'
+
+# Grabbed from https://github.com/oti/slack-reaction-decomoji/blob/master/import.rb
+module SlackBigEmoji
+  class Uploader
+    BASE_DIR = File.expand_path(File.dirname(__FILE__))
+
+    def initialize(dir)
+      @dir = dir
+      @page = nil
+      @agent = Mechanize.new
+    end
+    attr_accessor :page, :agent
+
+    def upload_emojis
+      move_to_emoji_page
+      push_emojis
+    end
+
+    private
+
+    def login
+      team_name  = ask('Your slack team name (subdomain): ')
+      email      = ask('Login email: ')
+      password   = ask('Login password (hidden): ') { |q| q.echo = false }
+
+      emoji_page_url = "https://#{team_name}.slack.com/admin/emoji"
+
+      page = agent.get(emoji_page_url)
+      page.form.email = email
+      page.form.password = password
+      @page = page.form.submit
+    end
+
+    def enter_two_factor_authentication_code
+      page.form['2fa_code'] = ask('Your two factor authentication code: ')
+      @page = page.form.submit
+    end
+
+    def move_to_emoji_page
+      loop do
+        if page && page.form['signin_2fa']
+          enter_two_factor_authentication_code
+        else
+          login
+        end
+
+        break if page.title.include?('Emoji')
+        puts 'Login failure. Please try again.'
+        puts
+      end
+    end
+
+    def push_emojis
+      Dir.glob("#{@dir}/*.png").sort.each do |path|
+        basename = File.basename(path, '.*')
+
+        # skip if already exists
+        next if page.body.include?(":#{basename}:")
+
+        puts "importing #{basename}..."
+
+        form = page.form_with(action: '/customize/emoji')
+        form['name'] = basename
+        form.file_upload.file_name = path
+        @page = form.submit
+      end
+    end
+  end
+end

data/lib/slack_big_emoji/version.rb

@@ -0,0 +1,3 @@
+module SlackBigEmoji
+  VERSION = '0.1.0'
+end

data/slack-big-emoji.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slack_big_emoji/version'
+
+Gem::Specification.new do |s|
+  s.name          = "slack-big-emoji"
+  s.version       = SlackBigEmoji::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = ["kinduff"]
+  s.email         = ["abarcadabra@gmail.com"]
+
+  s.summary       = %q{Command-line tool to create big emojis for Slack.}
+  s.description   = %q{Slack Big Emoji is a ruby command-line tool (see support) that helps out with the generation of big emojis to a Slack team.}
+  s.homepage      = "http://github.com/kinduff/slack-big-emoji"
+  s.license       = "MIT"
+
+  s.require_paths    = %w[lib]
+  s.files            = `git ls-files`.split($\)
+  s.executables      = %w[slack-big-emoji]
+  s.test_files       = s.files.grep(%r{^spec/})
+  s.extra_rdoc_files = %w[README.md]
+
+  s.add_dependency "mechanize", "~> 2.7.5"
+  s.add_dependency "highline", "~> 1.7.8"
+  s.add_dependency "mini_magick", "~> 4.7.2"
+
+  s.add_development_dependency "bundler", "~> 1.11"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rspec", "~> 3.0"
+end

data/spec/slack_big_emoji/slack_big_emoji_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SlackBigEmoji do
+  it 'has a version number' do
+    expect(SlackBigEmoji::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'slack_big_emoji'

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: slack-big-emoji
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kinduff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.5
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.8
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Slack Big Emoji is a ruby command-line tool (see support) that helps
+  out with the generation of big emojis to a Slack team.
+email:
+- abarcadabra@gmail.com
+executables:
+- slack-big-emoji
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".gitignore"
+- ".rbenv-gemsets"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- _config.yml
+- bin/slack-big-emoji
+- lib/slack_big_emoji.rb
+- lib/slack_big_emoji/cli.rb
+- lib/slack_big_emoji/converter.rb
+- lib/slack_big_emoji/uploader.rb
+- lib/slack_big_emoji/version.rb
+- slack-big-emoji.gemspec
+- spec/slack_big_emoji/slack_big_emoji_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/kinduff/slack-big-emoji
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Command-line tool to create big emojis for Slack.
+test_files:
+- spec/slack_big_emoji/slack_big_emoji_spec.rb
+- spec/spec_helper.rb