slack-progress 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b51479edb2c2459ae802ce4132f0321219d07d9
+  data.tar.gz: 487ad208178bcd568c7c5bcc489850812ad877f8
+SHA512:
+  metadata.gz: 7b9c1e95f74e9a8ae722bf0948196576271cdeb0baa490cd90653d3c9f3380fbb966aaadcb74f1f2f7ffc4109e80ca00a12ce25b176928891ee1df0a6dc8b046
+  data.tar.gz: 5cdad3cc687948035afc3a23e34779b38d97ba7d9739c22712653738977cd83d94727d8ac4a6de153f55092312cd24c1b76b99fe426ed7f77cdeef1a5e51bae1

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+test_script.rb

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 2.0.2

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    slack-progress (0.1.0)
+      faraday
+      json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    faraday (1.0.0)
+      multipart-post (>= 1.2, < 3)
+    json (2.3.0)
+    multipart-post (2.1.1)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  slack-progress!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Supreet
+
+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,58 @@
+# SlackProgress
+
+## Demo
+
+![Demo](https://i.imgur.com/3BFrK53.gif)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slack-progress'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slack-progress
+
+## Usage
+Pre-requisites:
+- A slack app for your workspace with `chat:write` permissions.
+- Channel ID where messages should be posted (starts with 'C')
+Then you can run the following 
+```ruby
+token = YOUR_BOT_TOKEN_HERE # Required
+channel_id = YOUR_CHANNEL_ID_HERE # Required (Note: this is different from Channel name)
+title = 'My Progress:' # Optional (Default is '')
+
+p = SlackProgress.new(token, channel_id, {title: title})
+thread_id = nil
+count = 0
+
+while count <= 50
+  response = p.update_progress(thread_id: thread_id, current_value: count, max_value: 50)
+  thread_id = response.thread_id
+  count += 1
+  sleep (1)
+end
+```
+
+## 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/supreet321/slack-progress.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "slack/progress"
+
+# 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(__FILE__)

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/lib/slack-progress/client.rb

@@ -0,0 +1,27 @@
+require 'slack-progress/message_builder'
+require 'slack-progress/options_parser'
+require 'slack-progress/connection'
+
+module SlackProgress
+  class Client
+
+    attr_reader :parsed_options
+
+    def initialize(token, channel_id, options = {})
+      raise ArgumentError, 'Token required' if token.nil?
+      raise ArgumentError, 'Channel ID required' if channel_id.nil?
+
+      @token = token
+      @channel_id = channel_id
+      @parsed_options   = OptionsParser.new(options).parse
+    end
+
+    def update_progress(thread_id: nil, current_value:, max_value:)
+      message_builder = MessageBuilder.new(parsed_options.formatting_options)
+      text = message_builder.build_message(current_value, max_value)
+
+      connection = Connection.new(@token, @channel_id)
+      connection.send_request(text, thread_id)
+    end
+  end
+end

data/lib/slack-progress/connection.rb

@@ -0,0 +1,62 @@
+require 'faraday'
+require 'json'
+
+module SlackProgress
+  class Connection
+
+    NEW_MESSAGE_URL = 'https://slack.com/api/chat.postMessage'
+    UPDATE_MESSAGE_URL = 'https://slack.com/api/chat.update'
+
+    class Response < OpenStruct
+      def initialize(status, thread_id, body)
+        super(status: status, thread_id: thread_id, body: body)
+      end
+    end
+
+    def initialize(token, channel_id)
+      @token = token
+      @channel_id = channel_id
+    end
+
+    def send_request(text, thread_id)
+      url = thread_id.nil? ? NEW_MESSAGE_URL : UPDATE_MESSAGE_URL
+      data = build_form_data(text, thread_id)
+
+      raw_response = Faraday.post(url) do |req|
+        req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+        req.body = URI.encode_www_form(data)
+        req.options[:timeout] = 2
+        req.options[:open_timeout] = 2
+      end
+
+      handle_errors(raw_response)
+      parsed_response(raw_response)
+    end
+
+    private
+
+    def build_form_data(text, thread_id)
+      form_data = { token: @token, channel: @channel_id, text: text }
+      form_data.merge!(ts: thread_id) if thread_id
+      form_data.merge!(@app_options.to_h)
+      form_data
+    end
+
+    def handle_errors(response)
+      raise SlackProgress::ConnectionError, "Received #{response.status}" unless response.success?
+
+      parsed_response = JSON.parse(response.body)
+      if parsed_response['ok'] == false
+        raise SlackProgress::InvalidRequestError, "Error: #{parsed_response['error']}"
+      end
+    end
+
+    def parsed_response(response)
+      body = response.body
+      status = response.status
+      thread_id = JSON.parse(body).fetch('ts', nil)
+
+      Response.new(status, thread_id, body)
+    end
+  end
+end

data/lib/slack-progress/error.rb

@@ -0,0 +1,4 @@
+module SlackProgress
+  class InvalidRequestError < StandardError; end
+  class ConnectionError < StandardError; end
+end

data/lib/slack-progress/message_builder.rb

@@ -0,0 +1,26 @@
+module SlackProgress
+  class MessageBuilder
+
+    def initialize(formatting_options)
+      @formatting_options = formatting_options
+    end
+
+    def build_message(current_value, max_value)
+      num_boxes = 10
+
+      ratio = current_value.to_f / max_value.to_f
+      percentage = (ratio * 100).round(1)
+
+      fill_count = (percentage / num_boxes).round
+      remaining_count = num_boxes - fill_count
+
+      message = @formatting_options.title
+      message += "\n"
+      message += (@formatting_options.completed_filler) * fill_count
+      message += (@formatting_options.remaining_filler) * remaining_count
+      message += " #{current_value} / #{max_value}"
+      message += " (#{percentage} %) finished."
+      message
+    end
+  end
+end

data/lib/slack-progress/options_parser.rb

@@ -0,0 +1,44 @@
+module SlackProgress
+  class OptionsParser
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def parse
+      OpenStruct.new(
+        app_options: app_options,
+        formatting_options: formatting_options,
+      )
+    end
+
+    private
+
+    def app_options
+      OpenStruct.new(
+        # username: username,
+        # icon_emoji: icon_emoji,
+      )
+    end
+
+    def formatting_options
+      OpenStruct.new(
+        remaining_filler: remaining_filler,
+        completed_filler: completed_filler,
+        title: title,
+      )
+    end
+
+    def remaining_filler
+      @options[:remaining_filler] || ':white_medium_square:'
+    end
+
+    def completed_filler
+      @options[:completed_filler] || ':black_medium_square:'
+    end
+
+    def title
+      @options[:title] || ''
+    end
+  end
+end

data/lib/slack-progress/version.rb

@@ -0,0 +1,3 @@
+module SlackProgress
+  VERSION = "0.1.0"
+end

data/lib/slack-progress.rb

@@ -0,0 +1,9 @@
+require 'slack-progress/version'
+require 'slack-progress/client'
+require 'slack-progress/error'
+
+module SlackProgress
+  def self.new(token, channel_id, options={})
+    SlackProgress::Client.new(token, channel_id, options)
+  end
+end

data/slack-progress.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "slack-progress/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "slack-progress"
+  spec.version       = SlackProgress::VERSION
+  spec.authors       = ["Supreet"]
+  spec.email         = ["supreets123@gmail.com"]
+
+  spec.summary       = %q{Send progress updates to Slack}
+  spec.description   = %q{Send progress updates to Slack}
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "json"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: slack-progress
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Supreet
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Send progress updates to Slack
+email:
+- supreets123@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/slack-progress.rb
+- lib/slack-progress/client.rb
+- lib/slack-progress/connection.rb
+- lib/slack-progress/error.rb
+- lib/slack-progress/message_builder.rb
+- lib/slack-progress/options_parser.rb
+- lib/slack-progress/version.rb
+- slack-progress.gemspec
+homepage: 
+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.14
+signing_key: 
+specification_version: 4
+summary: Send progress updates to Slack
+test_files: []