slack_status_tracker 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6be6ef55f798ad9138a45627c33de4b7495e4c51
+  data.tar.gz: 9e12274c476c0552188bd6bb1e22470da58631c2
+SHA512:
+  metadata.gz: 789c8d5582d4c5f64bf42b35e3a6f2ca0ba7360e5be852c4e7d7629202f6f5f590dc48a1ebf062bdd159b54c217ec3e41da19491b686b1c17506a2d4ba9bc5fe
+  data.tar.gz: 2ffad31ddd23ab6ed7a0a7f7e991c3573ee152b1f506d26ded4e20eacd454edb1c79a0607561ec1108597a2e3eed84a9946acb998978957ea38e3927788d20d5

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+# JetBrains
+.idea
+# Vagrant
+.vagrant
+# Cloud 9
+.c9
+# Environment Configuration
+.env
+# Test output
+slack_online_users.txt

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+slack_status_tracker

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at kopz9999@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in slack_status_tracker.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kyoto Kopz
+
+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,99 @@
+# SlackStatusTracker
+
+Command line tool to get the number of online users in Slack at a given time.
+This tool is a scrapper based on [Watir](https://github.com/watir/watir).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slack_status_tracker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slack_status_tracker
+
+## Usage
+
+To ensure the command line tool is installed, run the following command:
+
+    $ slack_status_tracker -h
+
+You should get the available options:
+
+```bash
+Usage: slack_status_tracker [options]
+    -s, --start                      Start to track
+    -o, --output [FILE_PATH]         Output file (default slack_online_users.txt)
+        --channels c1,c2,c3          Slack channels
+        --driver [BROWSER_DRIVER]    Browser Driver (default chrome)
+    -f, --frequency [MINUTES]        Time minutes frequency (default 30)
+    -u, --username USERNAME          Slack Username
+    -p, --password PASSWORD          Slack Password
+
+Common options:
+    -h, --help                       Show this message
+        --version                    Show version
+```
+
+### One time output
+
+The expected results are going to be printed in the command line and saved to 
+a file named slack_online_users.txt, which should be located in the same path 
+you ran the command:
+```bash
+slack_status_tracker -u slack_username -p slack_password --channels channel_1
+```
+Output:
+```bash
+Time                            Online Users
+2016-08-01 09:00:55 +0000       11
+```
+
+### Daemon
+
+Just append the -s option to keep it running every n minutes you want 
+(by default 30):
+
+```bash
+slack_status_tracker -s -u slack_username -p slack_password --channels channel_1
+```
+Output:
+```bash
+Time                            Online Users
+2016-08-01 09:00:55 +0000       11
+```
+
+For every 10 min
+
+```bash
+slack_status_tracker -s -u slack_username -p slack_password --channels channel_1
+-f 10
+```
+Output:
+```bash
+Time                            Online Users
+2016-08-01 09:00:55 +0000       11
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/slack_status_tracker. 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/Vagrantfile

@@ -0,0 +1,13 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# All Vagrant configuration is done below. The "2" in Vagrant.configure
+# configures the configuration version (we support older styles for
+# backwards compatibility). Please don't change it unless you know what
+# you're doing.
+Vagrant.configure(2) do |config|
+  config.vm.box = "ubuntu/trusty64"
+  config.vm.provision :shell, path: "bootstrap.sh"
+  config.vm.provision :shell, path: "install-rvm.sh", args: "stable", privileged: false
+  config.vm.provision :shell, path: "install-ruby.sh", args: "2.3.1", privileged: false
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "slack_status_tracker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bootstrap.sh

@@ -0,0 +1,31 @@
+sudo locale-gen en_US.UTF-8
+sudo update-locale LANG=en_US.UTF-8
+sudo update-locale LC_ALL=en_US.UTF-8
+
+sudo apt-get update
+sudo apt-get install -y build-essential git curl libxslt1-dev libxml2-dev libssl-dev
+
+# postgres
+echo "deb http://apt.postgresql.org/pub/repos/apt/ precise-pgdg main " | sudo tee -a /etc/apt/sources.list.d/pgdg.list
+sudo wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -
+sudo apt-get update
+sudo apt-get install -y postgresql-9.3 libpq-dev
+echo '# "local" is for Unix domain socket connections only
+local   all             all                                  trust
+# IPv4 local connections:
+host    all             all             0.0.0.0/0            trust
+# IPv6 local connections:
+host    all             all             ::/0                 trust' | sudo tee /etc/postgresql/9.3/main/pg_hba.conf
+sudo sed -i "s/#listen_addresses = 'localhost'/listen_addresses = '*'/g" /etc/postgresql/9.3/main/postgresql.conf
+sudo /etc/init.d/postgresql restart
+sudo su - postgres -c 'createuser -s vagrant'
+
+# redis
+sudo apt-get install -y python-software-properties
+sudo add-apt-repository -y ppa:rwky/redis
+sudo apt-get update
+sudo apt-get install -y redis-server
+
+echo "All done installing!
+
+Next steps: type 'vagrant ssh' to log into the machine."

data/exe/slack_status_tracker

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "slack_status_tracker"
+
+SlackStatusTracker::ReportManager.instance.cmd

data/install-ruby.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+source $HOME/.rvm/scripts/rvm
+
+rvm use --default --install $1
+
+shift
+
+if (( $# ))
+then gem install $@
+fi
+
+rvm cleanup all

data/install-rvm.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3
+curl -sSL https://get.rvm.io | bash -s $1

data/lib/slack_status_tracker/report_manager.rb

@@ -0,0 +1,113 @@
+module SlackStatusTracker
+  class ReportManager
+    include Singleton
+
+    attr_accessor :output_path
+
+    def cmd
+      options = parse_options ARGV
+      set_output options
+      frequency = options.fetch :frequency
+      append_to_output "Time\t\t\t\tOnline Users"
+      if options[:start]
+        while true
+          process_channels options
+          sleep frequency*60
+        end
+      else
+        process_channels options
+      end
+    end
+
+    def process_channels(options = {})
+      channels = options.fetch :channels
+      username = options.fetch :username
+      password = options.fetch :password
+      driver = options.fetch :driver
+      total = 0
+      time = Time.now
+
+      channels.each do |c|
+        scrapper = SlackStatusTracker::Scrapper.new(username, password,
+                                                    driver, c)
+        begin
+          scrapper.retrieve_users
+          total += scrapper.current_online_users
+        rescue => e
+          puts e.backtrace
+        end
+      end
+      append_to_output "#{time}\t#{total}"
+    end
+
+    def parse_options(args)
+      options = { frequency: 30, driver: :chrome }
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: slack_status_tracker [options]"
+
+        opts.on("-s", "--start", "Start to track") do |s|
+          options[:start] = true
+        end
+
+        opts.on("-o", "--output [FILE_PATH]",
+                "Output file (default slack_online_users.txt)") do |o|
+          options[:output] = o
+        end
+
+        opts.on("--channels c1,c2,c3", Array,
+                "Slack channels") do |channels|
+          options[:channels] = channels
+        end
+
+        opts.on("--driver [BROWSER_DRIVER]", String,
+                "Browser Driver (default chrome)") do |d|
+          options[:driver] = d.to_sym
+        end
+
+        opts.on("-f", "--frequency [MINUTES]", Integer,
+                "Time minutes frequency (default 30)") do |f|
+          options[:frequency] = f || FREQUENCY
+        end
+
+        opts.on("-u", "--username USERNAME", "Slack Username") do |u|
+          options[:username] = u
+        end
+
+        opts.on("-p", "--password PASSWORD", "Slack Password") do |p|
+          options[:password] = p
+        end
+
+        opts.separator ""
+        opts.separator "Common options:"
+
+        # No argument, shows at tail.  This will print an options summary.
+        # Try it and see!
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          exit
+        end
+
+        opts.on_tail("--version", "Show version") do
+          puts SlackStatusTracker::VERSION
+          exit
+        end
+      end
+      opt_parser.parse!(args)
+      options
+    end
+
+    protected
+
+    def append_to_output(content)
+      puts content
+      open(self.output_path, 'a') { |f| f.puts content }
+    end
+
+    def set_output(options)
+      self.output_path = options[:output]
+      if self.output_path.nil?
+        self.output_path = File.join(Dir.pwd, 'slack_online_users.txt')
+      end
+    end
+  end
+end

data/lib/slack_status_tracker/scrapper.rb

@@ -0,0 +1,53 @@
+module SlackStatusTracker
+  class Scrapper
+    attr_accessor :browser
+    attr_accessor :username
+    attr_accessor :password
+    attr_accessor :channel
+    attr_accessor :current_online_users
+
+    def initialize(username, password, driver, channel)
+      self.username = username
+      self.password = password
+      self.channel = channel
+      headless = Headless.new
+      headless.start
+      self.browser = Watir::Browser.new driver
+      self.current_online_users = 0
+    end
+
+    def retrieve_users
+      init_slack
+      login
+      init_team
+      read_list
+      browser.close
+    end
+
+    protected
+
+    def read_list
+      browser.element(css: '#active_members_list').wait_until_present
+      browser.elements(css: '#active_members_list .team_list_item').each do |el|
+        presence_bubble = el.element(css: 'span.presence')
+        if presence_bubble.attribute_value("class").split(' ').include? 'active'
+          self.current_online_users+=1
+        end
+      end
+    end
+
+    def init_slack
+      self.browser.goto "https://#{self.channel}.slack.com/"
+    end
+
+    def login
+      self.browser.text_field(:css => '#email').value = self.username
+      self.browser.text_field(:css => '#password').set self.password
+      self.browser.button(:css => '#signin_btn').click
+    end
+
+    def init_team
+      self.browser.goto "https://#{self.channel}.slack.com/team"
+    end
+  end
+end

data/lib/slack_status_tracker/version.rb

@@ -0,0 +1,3 @@
+module SlackStatusTracker
+  VERSION = "0.1.0.pre"
+end

data/lib/slack_status_tracker.rb

@@ -0,0 +1,15 @@
+# Singleton
+require "singleton"
+require "watir"
+require 'headless'
+require 'optparse'
+# App
+require "slack_status_tracker/version"
+require "slack_status_tracker/report_manager"
+require "slack_status_tracker/scrapper"
+
+module SlackStatusTracker
+  def self.root
+    File.expand_path '../..', __FILE__
+  end
+end

data/slack_status_tracker.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slack_status_tracker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slack_status_tracker"
+  spec.version       = SlackStatusTracker::VERSION
+  spec.authors       = ["Kyoto Kopz"]
+  spec.email         = ["kopz9999@gmail.com"]
+
+  spec.summary       = 'Command line tool to get the status of current users'
+  spec.homepage      = 'https://github.com/kopz9999/slack_status_tracker'
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'watir', '~> 4.0'
+  spec.add_dependency 'headless', '2.2.3'
+  spec.add_development_dependency "pry", ">= 0.10.3"
+  spec.add_development_dependency "dotenv", ">= 2.1.1"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: slack_status_tracker
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Kyoto Kopz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: watir
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: headless
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: 
+email:
+- kopz9999@gmail.com
+executables:
+- slack_status_tracker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- Vagrantfile
+- bin/console
+- bin/setup
+- bootstrap.sh
+- exe/slack_status_tracker
+- install-ruby.sh
+- install-rvm.sh
+- lib/slack_status_tracker.rb
+- lib/slack_status_tracker/report_manager.rb
+- lib/slack_status_tracker/scrapper.rb
+- lib/slack_status_tracker/version.rb
+- slack_status_tracker.gemspec
+homepage: https://github.com/kopz9999/slack_status_tracker
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Command line tool to get the status of current users
+test_files: []