remote-coffee-slack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8cac3181a643cd6331c3f40df9fa674f5b5cf37f60ed9d333f3e27653868303a
+  data.tar.gz: a3ea3e71d1879ccd90d9cf79f2ecfa6970798864d5fcf867c64e12dbb9cae2f4
+SHA512:
+  metadata.gz: e8c4414242cc5b851a009fb37e7a115d2d4e7095250204a07ddbffb6c9275a87c0feba2b3bb18203150272d9e090ede4343e0055484c8ac88b2651846e754928
+  data.tar.gz: 7f7df451900a7adc839e1fa3c8a11b019df664ca336c6b78417eb70069eab65630ad36977e1987094d0c0a08371e184e41826d22f31ad3ad632ebe7361a62253

data/.env.sample

@@ -0,0 +1,2 @@
+SLACK_BOT_TOKEN = your_app_token
+SLACK_CHANNEL = '#general'

data/.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: CI
+on:
+  pull_request:
+    branches: [ master ]
+  push:
+    branches: [ master ]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby_version: [ '2.5', '2.6', '2.7' ]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup ruby ${{ matrix.ruby_version }}
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+      - name: Setup cache key and directory for gems cache
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gem-use-ruby-${{ matrix.ruby_version }}-${{ hashFiles('**/Gemfile.lock') }}
+      - name: Bundle install
+        run: |
+          gem install bundler
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+      - name: Run tests
+        run: |
+          bundle exec rake test
+        env:
+          SLACK_BOT_TOKEN: TEST-TOKEN
+          SLACK_CHANNEL: '#general'

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.env
+.env.test

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.4
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at JuanCrg90@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in remote_coffee_slack.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+
+group :test do
+  gem "minitest", "~> 5.0"
+  gem 'vcr'
+  gem 'webmock'
+end
+
+group :test, :development do
+  gem "pry"
+  gem 'dotenv', "~> 2.7.6"
+end

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    remote-coffee-slack (0.1.0)
+      slack-ruby-client (~> 0.15.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coderay (1.1.3)
+    crack (0.4.4)
+    dotenv (2.7.6)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    gli (2.19.2)
+    hashdiff (1.0.1)
+    hashie (4.1.0)
+    method_source (1.0.0)
+    minitest (5.14.2)
+    multipart-post (2.1.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rake (12.3.3)
+    slack-ruby-client (0.15.1)
+      faraday (>= 1.0)
+      faraday_middleware
+      gli
+      hashie
+      websocket-driver
+    vcr (6.0.0)
+    webmock (3.9.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dotenv (~> 2.7.6)
+  minitest (~> 5.0)
+  pry
+  rake (~> 12.0)
+  remote-coffee-slack!
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Juan Carlos Ruiz
+
+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,68 @@
+# RemoteCoffeeSlack
+![CI](https://github.com/Calzada-Code/remote-coffee-slack/workflows/CI/badge.svg)
+
+A Ruby gem that helps you to create groups for a remote coffee in your Slack organization.
+
+![remote-cofee-slack](./remote-coffee-slack.png)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'remote_coffee_slack'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install remote_coffee_slack
+
+
+## Usage
+
+Create a new slack app in your slack workspace and add the following Bot Token Scopes:
+`channels:read `, `chat:write`, `users:read`
+
+Initalize the gem adding the following block:
+
+```ruby
+RemoteCoffeeSlack.configure do |config|
+  config.slack_bot_token = your-Bot-User-OAuth-Access-Token
+  config.slack_channel = the-slack-channel-what-you-will-take-as-water-cooler
+end
+```
+
+In your Ruby application where you want to trigger the `RemoteCoffeeSlack` pairing event you should call
+
+```ruby
+RemoteCoffeeSlack.notify_next_session
+```
+
+This will action will perform the following steps:
+- Get the users inside the configured channel.
+- Create the groups for the next coffee session.
+- Publish the list in the confifured channel.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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]/remote_coffee_slack. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Calzada-Code/remote-coffee-slack/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RemoteCoffeeSlack project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Calzada-Code/remote-coffee-slack/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require 'dotenv/load'
+require "remote_coffee_slack"
+
+RemoteCoffeeSlack.configure do |config|
+  config.slack_bot_token = ENV['SLACK_BOT_TOKEN']
+  config.slack_channel = ENV['SLACK_CHANNEL']
+end
+
+ require "pry"
+ Pry.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/lib/remote_coffee_slack.rb

@@ -0,0 +1,33 @@
+require "remote_coffee_slack/version"
+
+require "remote_coffee_slack/slack_client"
+require "remote_coffee_slack/members"
+require "remote_coffee_slack/session_notifier"
+
+module RemoteCoffeeSlack
+  class << self
+    attr_accessor :config
+    attr_accessor :slack_client
+  end
+
+  def self.configure
+    self.config ||= Configuration.new
+    yield config
+  end
+
+  def self.slack_client
+    @slack_client ||= SlackClient.new.client
+  end
+
+  def self.select_coffee_mates
+    @select_coffee_mates ||= Members.select_coffee_mates(slack_client)
+  end
+
+  def self.notify_next_session
+    SessionNotifier.perform(slack_client, select_coffee_mates)
+  end
+
+  class Configuration
+    attr_accessor :slack_bot_token, :slack_channel
+  end
+end

data/lib/remote_coffee_slack/members.rb

@@ -0,0 +1,50 @@
+module RemoteCoffeeSlack
+  class Members
+    MATES_PER_GROUP = 2
+
+    def initialize(client)
+      @client = client
+      @members = retrieve_channel_members
+    end
+
+    def self.select_coffee_mates(client)
+      new(client).select_coffee_mates
+    end
+
+    def select_coffee_mates
+      members_handlers.shuffle.each_slice(MATES_PER_GROUP).to_a
+    end
+
+    private
+
+    attr_reader :client, :members
+
+    def retrieve_channel_members
+      channel_members = []
+      params = {
+        channel: RemoteCoffeeSlack.config.slack_channel,
+        limit: 10,
+        sleep_interval: 5,
+        max_retries: 20
+      }
+
+      client.conversations_members(params) do |response|
+        channel_members.concat(response.members)
+      end
+
+      channel_members
+    end
+
+    def members_handlers
+      human_members.map do |member|
+        "@#{member}"
+      end
+    end
+
+    def human_members
+    members.reject do |member|
+      client.users_info(user: member).user.is_bot
+    end
+    end
+  end
+end

data/lib/remote_coffee_slack/session_notifier.rb

@@ -0,0 +1,36 @@
+module RemoteCoffeeSlack
+  class SessionNotifier
+    def initialize(client, coffee_mates)
+      @client = client
+      @coffee_mates = coffee_mates
+    end
+
+    def perform
+      client.chat_postMessage(
+        channel: RemoteCoffeeSlack.config.slack_channel,
+        text: next_session_message,
+        as_user: true)
+    end
+
+    def self.perform(client, coffee_mates)
+      new(client, coffee_mates).perform
+    end
+
+    private
+
+    attr_reader :client, :coffee_mates
+
+    def next_session_message
+      <<-TEXT
+      The mates for the next coffee session are:
+      #{coffee_mates_formated}
+      TEXT
+    end
+
+    def coffee_mates_formated
+      coffee_mates.map do |mates|
+        "<#{mates.first}> and <#{mates.last}>\n"
+      end.join
+    end
+  end
+end

data/lib/remote_coffee_slack/slack_client.rb

@@ -0,0 +1,16 @@
+require 'slack-ruby-client'
+
+module RemoteCoffeeSlack
+  class SlackClient
+    attr_reader :client
+
+    def initialize
+      ::Slack.configure do |config|
+        config.token = RemoteCoffeeSlack.config.slack_bot_token
+        raise 'Missing API token' unless config.token
+      end
+
+      @client = Slack::Web::Client.new
+    end
+  end
+end

data/lib/remote_coffee_slack/version.rb

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

data/remote_coffee_slack.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/remote_coffee_slack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "remote-coffee-slack"
+  spec.version       = RemoteCoffeeSlack::VERSION
+  spec.authors       = ["Juan Carlos Ruiz"]
+  spec.email         = ["JuanCrg90@gmail.com"]
+
+  spec.summary       = %q{Organize remote coffee pairs in your slack workspace.}
+  spec.description   = %q{Organize remote coffee pairs in your slack workspace.}
+  spec.homepage      = "https://calzadacode.dev/"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Calzada-Code/remote-cofee-slack"
+  spec.metadata["changelog_uri"] = "https://github.com/Calzada-Code/remote-cofee-slack"
+
+  # 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_dependency 'slack-ruby-client', '~> 0.15.1'
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: remote-coffee-slack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Juan Carlos Ruiz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slack-ruby-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+description: Organize remote coffee pairs in your slack workspace.
+email:
+- JuanCrg90@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.sample"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/remote_coffee_slack.rb
+- lib/remote_coffee_slack/members.rb
+- lib/remote_coffee_slack/session_notifier.rb
+- lib/remote_coffee_slack/slack_client.rb
+- lib/remote_coffee_slack/version.rb
+- remote-coffee-slack.png
+- remote_coffee_slack.gemspec
+homepage: https://calzadacode.dev/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://calzadacode.dev/
+  source_code_uri: https://github.com/Calzada-Code/remote-cofee-slack
+  changelog_uri: https://github.com/Calzada-Code/remote-cofee-slack
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Organize remote coffee pairs in your slack workspace.
+test_files: []