slacktail 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 90c2bc64c84bf955e31f8ffc852e30d84811d3e8efe62d55e1c18186215fd938
+  data.tar.gz: aed391d0419c87b308dd909eaa7d515e1c84cdd24374eb56e1b779a3e7dbabf3
+SHA512:
+  metadata.gz: ea9f8f39ce1bf2c03fa72402f6feb06828de1674bb9d91aa57add31eefda72afb2a1c6243fd5a17c6d7884d3ff5752473a2b8907c729f4337d52a7e105da5445
+  data.tar.gz: fbe56116ee1b230ba647f3af890d3f962365b8d2e222f41c2130848d05c52e04717174861c36a2e41877c5b1ed6d082f45fe72cc0dedac3f844dc0d730cf4d59

data/README.md

@@ -0,0 +1,52 @@
+Slacktail
+==================================================
+
+[![Gem Version](https://badge.fury.io/rb/slacktail.svg)](https://badge.fury.io/rb/slacktail)
+[![Build Status](https://travis-ci.com/DannyBen/slacktail.svg?branch=master)](https://travis-ci.com/DannyBen/slacktail)
+[![Maintainability](https://api.codeclimate.com/v1/badges/.../maintainability)](https://codeclimate.com/github/DannyBen/slacktail/maintainability)
+
+---
+
+Slacktail is a single-purpose command line utility for follwoing messages 
+sent to your Slack organization chat.
+
+---
+
+Installation
+--------------------------------------------------
+
+    $ gem install slacktail
+
+
+Authorization
+--------------------------------------------------
+
+
+1. Obtain an API key from Slack.
+   In your Slack settings, go to [Custom Integrations] and create a new 
+   Bot Application. Then, find the API Token in the bot's configuration page.  
+
+2. Set the `SLACK_API_TOKEN` environemnt variable to the API Token. This 
+   should probably be set in your `~/.bashrc`, with 
+   `export SLACK_API_TOKEN=<your token>`
+
+3. Invite your bot to any channel you want to monitor. Type 
+   `/invite @<botname>` in any channel.
+
+
+Usage
+--------------------------------------------------
+
+Follow all channels:
+
+    $ slacktail
+
+Follow specific channels
+    
+    $ slacktail general development lobby
+
+
+
+---
+
+[Custom Integrations]: https://my.slack.com/apps/manage/custom-integrations

data/bin/slacktail

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require 'slacktail'
+
+runner = MisterBin::Runner.new handler: Slacktail::Command
+
+begin
+  exit runner.run ARGV
+rescue => e
+  puts e.backtrace.reverse if ENV['DEBUG']
+  say! "!txtred!#{e.class}: #{e.message}"
+  exit 1
+end

data/lib/slacktail/attachment.rb

@@ -0,0 +1,18 @@
+module Slacktail
+  class Attachment < Base
+    include HasText
+
+    def color
+      data.color || ''
+    end
+    
+    def fields
+      @fields ||= fields!
+    end
+
+    def fields!
+      return [] unless data.fields
+      data.fields.map { |field| Field.new field }
+    end
+  end
+end

data/lib/slacktail/base.rb

@@ -0,0 +1,9 @@
+module Slacktail
+  class Base
+    attr_reader :data
+    
+    def initialize(data)
+      @data = data
+    end
+  end
+end

data/lib/slacktail/client.rb

@@ -0,0 +1,23 @@
+module Slacktail
+  class Client
+    class << self
+      attr_writer :default
+
+      def default
+        @default ||= default!
+      end
+
+      def can_connect?
+        !!ENV['SLACK_API_TOKEN']
+      end
+
+      def default!
+        raise ArgumentError, 'Please set SLACK_API_TOKEN' unless can_connect?
+        Slack.configure { |c| c.token = ENV['SLACK_API_TOKEN'] }
+        Slack::RealTime::Client.new
+      end
+    end
+  end
+end
+
+  

data/lib/slacktail/command.rb

@@ -0,0 +1,43 @@
+module Slacktail
+  class Command < MisterBin::Command
+    include HasClient
+
+    version VERSION
+    summary "Show and follow slack messages in real time"
+
+    usage "slacktail [CHANNELS...]"
+    usage "slacktail (-h|--help|--version)"
+    
+    param "CHANNELS", "Channels to follow"
+
+    example "slacktail"
+    example "slacktail general debug"
+
+    def run(args = nil)
+      args ||= {}
+      @channels = args['CHANNELS'] || []
+
+      say "Connecting... " if Client.can_connect?
+
+      client.on :message do |data|
+        @message = Message.new data
+        @message.render unless skip?
+      end
+
+      client.on(:hello) { resay "!txtgrn!Ready\n" }
+      client.on(:closed) { |_data| say "Goodbye" }
+      client.start!
+    end
+
+  private
+
+    def skip?
+      return true if @message.empty?
+      return false if @channels.empty?
+      return false if @channels.include? @message.pure_channel
+      return true
+    end
+
+  end
+end
+

data/lib/slacktail/extensions/string.rb

@@ -0,0 +1,21 @@
+class String
+  def to_markdown
+    TTY::Markdown.parse self
+  end
+
+  def to_colsole_color
+    color = {
+      '000000' => :wht,
+      'ff0000' => :red,
+      '00ff00' => :grn,
+      '0000ff' => :blu,
+      'ffff00' => :ylw,
+      'ff00ff' => :pur,
+      '00ffff' => :cyn,
+      'ffffff' => :blk,
+    }
+
+    key = self.downcase
+    color.keys.include?(key) ? color[key] : :rst
+  end
+end

data/lib/slacktail/field.rb

@@ -0,0 +1,11 @@
+module Slacktail
+  class Field < Base
+    def key
+      data.title
+    end
+
+    def value
+      data.value
+    end
+  end
+end

data/lib/slacktail/has_client.rb

@@ -0,0 +1,9 @@
+module Slacktail
+  module HasClient
+    attr_writer :client
+
+    def client
+      @client ||= Client.default
+    end
+  end
+end

data/lib/slacktail/has_text.rb

@@ -0,0 +1,15 @@
+module Slacktail
+  module HasText
+    def text
+      @text ||= text!
+    end
+
+    def text!
+      data.text ? data.text.gsub(/```\n?/, '').strip : ''
+    end
+
+    def text_lines
+      text.split "\n"
+    end
+  end
+end

data/lib/slacktail/message.rb

@@ -0,0 +1,67 @@
+module Slacktail
+  class Message < Base
+    include MessageView, HasText, HasClient
+
+    def channel
+      @channel ||= channel!
+    end
+
+    def pure_channel
+      channel.gsub '#', ''
+    end
+
+    def color
+      if attachments.any?
+        attachments.first.color.to_colsole_color
+      else
+        :cyn
+      end
+    end
+
+    def items
+      @items ||= items!
+    end
+
+    def empty?
+      items.empty?
+    end
+
+    def user
+      if data.username
+        data.username
+      elsif data.bot_id
+        client.bots[data.bot_id].name
+      else
+        "anonymous"
+      end
+    end
+
+    def attachments
+      @attachments ||= attachments!
+    end
+
+  private
+
+    def items!
+      result = text_lines
+      attachments.each do |attachment|
+        result += attachment.text_lines
+        result += attachment.fields
+      end
+      result
+    end
+
+    def channel!
+      channel = client.channels[data.channel]
+      channel ? "##{channel.name}" : "@private"
+    end
+
+    def attachments!
+      return [] unless data.attachments
+      data.attachments.map do |attachment| 
+        Attachment.new attachment
+      end
+    end
+  end
+
+end

data/lib/slacktail/message_view.rb

@@ -0,0 +1,22 @@
+module Slacktail
+  module MessageView
+    include Colsole
+
+    def render
+      prefix = "!txt#{color}!▌!txtrst! "
+      now = Time.now.strftime "%H:%M"
+      say "#{prefix}!txtcyn!#{now} ➤ !bldcyn!@#{user}!txtcyn! ➤ #{channel}".strip
+
+      items.each do |line|
+        if line.is_a? String
+          say "#{prefix}#{line.to_markdown}".strip
+        elsif line.is_a? Field
+          say "#{prefix}!txtblu!#{line.key}!txtrst! : !txtgrn!#{line.value}".strip
+        end
+      end
+
+      say ""
+    end
+
+  end
+end

data/lib/slacktail/version.rb

@@ -0,0 +1,3 @@
+module Slacktail
+  VERSION = "0.0.1"
+end

data/lib/slacktail.rb

@@ -0,0 +1,13 @@
+require 'requires'
+require 'mister_bin'
+require 'slack-ruby-client'
+require 'tty-markdown'
+require 'byebug' if ENV['BYEBUG']
+
+requires \
+  'slacktail/base',
+  'slacktail/message_view',
+  'slacktail/has_text',
+  'slacktail/has_client',
+  'slacktail'
+

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: slacktail
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Danny Ben Shitrit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: mister_bin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: requires
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: slack-ruby-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: tty-markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Slacktail is a single-purpose command line utility for follwoing messages
+  sent to your Slack organization chat.
+email: db@dannyben.com
+executables:
+- slacktail
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/slacktail
+- lib/slacktail.rb
+- lib/slacktail/attachment.rb
+- lib/slacktail/base.rb
+- lib/slacktail/client.rb
+- lib/slacktail/command.rb
+- lib/slacktail/extensions/string.rb
+- lib/slacktail/field.rb
+- lib/slacktail/has_client.rb
+- lib/slacktail/has_text.rb
+- lib/slacktail/message.rb
+- lib/slacktail/message_view.rb
+- lib/slacktail/version.rb
+homepage: https://github.com/dannyben/slacktail
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Command line tool for following slack messages in real time
+test_files: []