discord-pomodoro 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 959920ddeba86b43e8c80fbb0e92260f58cacb886551baa16704983b0b2b13f4
+  data.tar.gz: 1401253cd2f9fa7608e7b13a6f7ce9732a8d54047863e4481a51c4ea3e167bb0
+SHA512:
+  metadata.gz: 84c036b8073fffabadfcbf1d15289fcf3356725451cd62239ea452bcc3068e551b9bcfcf9781e5adcc15de09bb563560d93ed90bbd7d07ef95b603e0e68962be
+  data.tar.gz: df3afcb555b8d54157d19b4ba24db7eb60bff0726f2344e6125ae4d3dfa015510a46842126126fc49269d47dbdad29f5a3de70eacfb1a6a68843899b340989ef

data/.dockerignore

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

data/.env.sample

@@ -0,0 +1,2 @@
+DISCORD_BOT_TOKEN=xxxxxx
+DISCORD_VOICE_CHANNEL_ID=xxxxxx

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-07-10
+
+- Initial release

data/Dockerfile

@@ -0,0 +1,13 @@
+FROM ruby
+
+RUN apt-get update && apt-get install -y \
+    libsodium-dev \
+    libopus-dev \
+    ffmpeg
+
+WORKDIR /app
+COPY . /app
+RUN bundle install
+RUN bundle exec rake install
+
+CMD discord-pomodoro

data/Dockerfile.dev

@@ -0,0 +1,14 @@
+FROM ruby
+
+RUN apt-get update && apt-get install -y \
+    libsodium-dev \
+    libopus-dev \
+    ffmpeg
+
+WORKDIR /app
+COPY . /app
+RUN bundle install
+RUN bundle exec rake install
+
+RUN bin/setup
+CMD bin/console

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in discord-pomodoro.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -0,0 +1,101 @@
+PATH
+  remote: .
+  specs:
+    discord-pomodoro (0.1.0)
+      discordrb (~> 3.4)
+      rufus-scheduler (~> 3.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    discordrb (3.4.0)
+      discordrb-webhooks (~> 3.3.0)
+      ffi (>= 1.9.24)
+      opus-ruby
+      rest-client (>= 2.0.0)
+      websocket-client-simple (>= 0.3.0)
+    discordrb-webhooks (3.3.0)
+      rest-client (>= 2.1.0.rc1)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    et-orbi (1.2.7)
+      tzinfo
+    event_emitter (0.2.6)
+    ffi (1.15.5)
+    fugit (1.5.3)
+      et-orbi (~> 1, >= 1.2.7)
+      raabro (~> 1.4)
+    http-accept (1.7.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    netrc (0.11.0)
+    opus-ruby (1.0.1)
+      ffi
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    raabro (1.4.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.30.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    rufus-scheduler (3.8.1)
+      fugit (~> 1.1, >= 1.1.6)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+    unicode-display_width (2.1.0)
+    websocket (1.2.9)
+    websocket-client-simple (0.5.1)
+      event_emitter
+      websocket
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  discord-pomodoro!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 megane42
+
+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,70 @@
+# Discord::Pomodoro
+
+- Discord::Pomodoro is a simple pomodoro bot for discord.
+- It sounds a chime on the specified voice channel
+  - at **:00 (meaning "Pomodoro Start")
+  - at **:50 (meaning "Breaktime Start")
+
+## Requirements
+
+- Discord bot token & invite the bot to your server
+  - https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token
+- Discord voice channel id
+  - https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-
+
+## Usage
+
+- Docker-compose way or Docker way is recommended because
+  - it's the easiest to boot
+  - it does not pollute your local environment
+
+### Docker-compose way
+
+```sh
+git clone https://github.com/megane42/discord-pomodoro.git
+cd discord-pomodoro
+echo DISCORD_BOT_TOKEN=****** >> .env
+echo DISCORD_VOICE_CHANNEL_ID=****** >> .env
+docker-compose run --rm app
+```
+
+### Docker way
+
+```sh
+export DISCORD_BOT_TOKEN=******
+export DISCORD_VOICE_CHANNEL_ID=******
+docker run --rm -it megane42/discord-pomodoro
+```
+
+### Rubygems way
+
+```sh
+sudo apt-get install libsodium-dev libopus-dev ffmpeg
+gem install discord-pomodoro
+export DISCORD_BOT_TOKEN=******
+export DISCORD_VOICE_CHANNEL_ID=******
+discord-pomodoro
+```
+
+## Development
+
+- Run console
+  - `docker-compose run --rm dev`
+- Run current gem
+  - `docker-compose run --rm dev discord-pomodoro`
+- Release
+  - `emacs CHANGELOG.md`
+  - `emacs lib/discord/pomodoro/version.rb`
+  - `bundle exec rake release`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/megane42/discord-pomodoro.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Sounds
+
+OtoLogic (CC BY 4.0) https://otologic.jp (Shortbridge17-1.mp3)

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "discord/pomodoro"
+
+# 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/discord-pomodoro.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/discord/pomodoro/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "discord-pomodoro"
+  spec.version       = Discord::Pomodoro::VERSION
+  spec.authors       = ["megane42"]
+  spec.email         = [""]
+
+  spec.summary       = "Simple pomodoro bot for discord"
+  spec.description   = "You can set timer and receive notify on your voice channel."
+  spec.homepage      = "https://github.com/megane42/discord-pomodoro/"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"]   = spec.homepage + "CHANGELOG.md"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "discordrb", "~> 3.4"
+  spec.add_dependency "rufus-scheduler", "~> 3.8"
+end

data/docker-compose.yml

@@ -0,0 +1,15 @@
+version: "3.9"
+services:
+  app:
+    build: .
+    env_file:
+      - .env
+
+  dev:
+    build:
+      context: .
+      dockerfile: Dockerfile.dev
+    env_file:
+      - .env
+    volumes:
+      - .:/app

data/exe/discord-pomodoro

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "discord/pomodoro"
+
+Discord::Pomodoro::Bot.new.run

data/lib/discord/pomodoro/bot.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "discordrb"
+require "rufus-scheduler"
+
+module Discord
+  module Pomodoro
+    # main bot
+    class Bot
+      def run
+        bot.run(true)
+        at_exit { bot.stop }
+
+        connect_voice_bot
+        schedule_chime
+
+        bot.join
+      end
+
+      private
+
+      def bot
+        @bot ||= Discordrb::Bot.new token: ENV["DISCORD_BOT_TOKEN"]
+      end
+
+      def voice_bot
+        @voice_bot ||= bot.voice_connect(ENV["DISCORD_VOICE_CHANNEL_ID"])
+      end
+
+      def connect_voice_bot
+        voice_bot
+      end
+
+      def chime_path
+        @chime_path ||= File.expand_path("../../../sounds/chime.mp3", __dir__)
+      end
+
+      def scheduler
+        @scheduler ||= Rufus::Scheduler.new
+      end
+
+      def schedule_chime
+        scheduler.cron("0 * * * *")  { voice_bot.play_file chime_path }
+        scheduler.cron("50 * * * *") { voice_bot.play_file chime_path }
+      end
+    end
+  end
+end

data/lib/discord/pomodoro/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Discord
+  module Pomodoro
+    VERSION = "0.1.0"
+  end
+end

data/lib/discord/pomodoro.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "discord/pomodoro/version"
+require "discord/pomodoro/bot"
+
+module Discord
+  module Pomodoro
+    class Error < StandardError; end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: discord-pomodoro
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- megane42
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: discordrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rufus-scheduler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: You can set timer and receive notify on your voice channel.
+email:
+- ''
+executables:
+- discord-pomodoro
+extensions: []
+extra_rdoc_files: []
+files:
+- ".dockerignore"
+- ".env.sample"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Dockerfile
+- Dockerfile.dev
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- discord-pomodoro.gemspec
+- docker-compose.yml
+- exe/discord-pomodoro
+- lib/discord/pomodoro.rb
+- lib/discord/pomodoro/bot.rb
+- lib/discord/pomodoro/version.rb
+- sounds/chime.mp3
+homepage: https://github.com/megane42/discord-pomodoro/
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/megane42/discord-pomodoro/
+  source_code_uri: https://github.com/megane42/discord-pomodoro/
+  changelog_uri: https://github.com/megane42/discord-pomodoro/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Simple pomodoro bot for discord
+test_files: []