heart_top 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3aa2fbbd860bce62565771866f90f7a00c9f6906
-  data.tar.gz: bc4598692f44e88eb4bf482d0cf42574749b0fe0
+  metadata.gz: d3323458320eb456251621f2133e26371244e472
+  data.tar.gz: 445a18599febd626d1cae53215f807c1794f3a66
 SHA512:
-  metadata.gz: 5d98a8792263913eb4177df37a9203a8a64b252ea81729df79c53c825acd7d17ce16feed050b3ed4da6238c07a0fa8a623c0a0f3d960008668eb8bf85f19182c
-  data.tar.gz: 79a70980f69b878462a6776238c69cf4ae480469fa6b94fb23cc3da1858670fd2f741b7bbe56a11fb1dc56cb1e4a38bdfc48c4998aa98e9b2a427708a5a1e4de
+  metadata.gz: 4dc44252dfe86817e04797ab4f1964cb63c2b5e278f6b21e9bb56835b52d9cb1c6f5aac43ee873f57dcd94baf7ec00513b15967f46d4d39fcbbd44777c1b3995
+  data.tar.gz: 35af02250311501ac9538739c7aa63b5375a91a4d6ffcf0e773fbbb7fc17ce21eb5e2dc87d6a3a3261c00bf2ab19b6c12fdb59472d1987df9c9ccb4daf141c24

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  Exclude: []
+  TargetRubyVersion: 2.3
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - 'spec/**/*'
+
+Metrics/LineLength:
+  Max: 130
+  Exclude:
+    - '*.gemspec'
+    - 'spec/**/*'
+
+Metrics/MethodLength:
+  Max: 120
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in heart_top.gemspec
 gemspec

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "heart_top"
+require 'bundler/setup'
+require 'heart_top'
 
 # 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.
@@ -10,5 +11,5 @@ require "heart_top"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/bin/hearttop

@@ -1,12 +1,13 @@
 #!/usr/bin/env ruby
 # encoding: UTF-8
+# frozen_string_literal: true
 
 # resolve bin path, ignoring symlinks
-require "pathname"
+require 'pathname'
 bin_file = Pathname.new(__FILE__).realpath
 
 # add self to libpath
-$:.unshift File.expand_path("../../lib", bin_file)
+$LOAD_PATH.unshift File.expand_path('../../lib', bin_file)
 
 require 'heart_top'
-HeartTop::CLI.run(*ARGV)
+HeartTop::CLI.run

data/heart_top.gemspec

@@ -1,32 +1,35 @@
 # coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "heart_top/version"
+require 'heart_top/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "heart_top"
+  spec.name          = 'heart_top'
   spec.version       = HeartTop::VERSION
-  spec.authors       = ["Faizal Zakaria"]
-  spec.email         = ["fzakaria@codegarage.co"]
+  spec.authors       = ['Faizal Zakaria']
+  spec.email         = ['fzakaria@codegarage.co']
 
-  spec.summary       = %q{HeartTop pings the heartbeat of your laptop every N seconds}
+  spec.summary       = 'HeartTop pings the heartbeat of your laptop every N seconds'
   spec.description   = "Have you ever go to free space, coffee shops or some random place to work, \
 and you need to to toilet for pee, or big business? Then worried what would happen to your laptop? \
 This tool could be the solution"
-  spec.homepage      = "https://github.com/faizalzakaria/heart_top"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/faizalzakaria/heart_top'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "bin"
+  spec.bindir        = 'bin'
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_dependency "terminal-table", "~> 1.8.0"
-  spec.add_dependency "rainbow", "~> 2.2.2"
-  spec.add_dependency "dante", "~> 0.2.0"
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.49'
+  spec.add_dependency 'terminal-table', '~> 1.8'
+  spec.add_dependency 'rainbow', '~> 2.2'
+  spec.add_dependency 'dante', '~> 0.2'
 end

data/lib/heart_top/agent.rb

@@ -1,26 +1,30 @@
+# frozen_string_literal: true
+
 require 'heart_top/plugin'
 
-class HeartTop::Agent
-  PLUGINS = %i(slack)
+module HeartTop
+  class Agent
+    PLUGINS = %i[slack].freeze
 
-  def initialize(interval: , verbose: )
-    @interval = interval
-    @verbose  = verbose
-  end
+    def initialize(interval:, verbose:)
+      @interval = interval
+      @verbose  = verbose
+    end
 
-  def run
-    while true do
-      execute_plugins
-      sleep @interval
+    def run
+      loop do
+        execute_plugins
+        sleep @interval
+      end
     end
-  end
 
-  private
+    private
 
-  def execute_plugins
-    puts 'executing ...' if @verbose
-    PLUGINS.each do |plugin|
-      Object.const_get("HeartTop::Plugin::#{plugin.capitalize}").send('ping')
+    def execute_plugins
+      puts 'executing ...' if @verbose
+      PLUGINS.each do |plugin|
+        Object.const_get("HeartTop::Plugin::#{plugin.capitalize}").instance.send('ping')
+      end
     end
   end
 end

data/lib/heart_top/cli.rb

@@ -1,116 +1,116 @@
+# frozen_string_literal: true
+
 require 'heart_top/agent'
 require 'getoptlong'
 require 'terminal-table'
 require 'rainbow'
 require 'dante'
 
-class HeartTop::CLI
-  attr_accessor :verbose, :interval
-
-  class UnsupportedCommand < StandardError; end
-
-  class << self
-	def run(*args)
-	  begin
-		parse_args!(args)
-	  rescue UnsupportedCommand => e
-		print_error(e.message)
-		exit
-	  end
-	  set_defaults
-	  print_details
-	  execute!
-	  true
-	end
-
-	private
-
-	def execute!
-	  send("#@command!")
-	end
-
-	def pid_path
-	  '/tmp/heartop.pid'
-	end
-
-	def log_path
-	  '/tmp/hearttop.log'
-	end
-
-	def start!
-	  options = {
-		interval: @interval,
-		verbose: @verbose
-	  }
-	  Dante::Runner
-		.new('hearttop')
-		.execute(daemonize: true, pid_path: pid_path, log_path: log_path) do |opts|
-		HeartTop::Agent.new(options).run
-	  end
-	end
-
-	def stop!
-	  Dante::Runner
-		.new('hearttop')
-		.execute(:kill => true, :pid_path => pid_path)
-	end
-
-	def set_defaults
-	  @interval ||= 10
-	  @verbose  ||= false
-	end
-
-	def parse_args!(args)
-	  opts = GetoptLong.new([ '--help', '-h', GetoptLong::NO_ARGUMENT ],
-						[ '--interval', '-i', GetoptLong::REQUIRED_ARGUMENT ],
-						[ '--verbose', '-v', GetoptLong::NO_ARGUMENT ])
-	  @interval = nil
-	  @verboes  = nil
-	  opts.each do |opt, arg|
-		case opt
-		when '--help'
-		  print_help
-		when '--interval'
-		  @interval = arg
-		when '--verbose'
-		  @verbose = true
-		end
-	  end
-	  @command = args.last
-	  unless supported_commands?(@command)
-		raise UnsupportedCommand.new(Rainbow("Unsupported command detected, ").red + Rainbow(@command).green)
-	  end
-	end
-
-	def supported_commands?(cmd)
-	  %w(stop start).include?(cmd)
-	end
-
-    def print_details
-      return unless @verbose
-      table = Terminal::Table.new do |t|
-        t << [Rainbow('verbose').green, Rainbow(@verbose).green]
-        t.add_row [Rainbow('interval').green, Rainbow(@interval).green]
-		t.add_row [Rainbow('command').green, Rainbow(@command).green]
+module HeartTop
+  class CLI
+    attr_accessor :verbose, :interval
+
+    class UnsupportedCommand < StandardError; end
+
+    class << self
+      def run
+        begin
+          parse_args!
+        rescue UnsupportedCommand => e
+          print_error(e.message)
+          exit
+        end
+        set_defaults
+        print_details
+        execute
+      end
+
+      private
+
+      def execute!
+        send("#{@command}!")
+      end
+
+      def pid_path
+        '/tmp/heartop.pid'
+      end
+
+      def log_path
+        '/tmp/hearttop.log'
+      end
+
+      def start
+        options = {
+          interval: @interval,
+          verbose: @verbose
+        }
+        Dante::Runner
+          .new('hearttop')
+          .execute(daemonize: true, pid_path: pid_path, log_path: log_path) do |_opts|
+          HeartTop::Agent.new(options).run
+        end
       end
-	  puts table
-    end
 
-	def print_error(msg)
-	  puts Rainbow(msg).red
-	end
+      def stop
+        Dante::Runner
+          .new('hearttop')
+          .execute(kill: true, pid_path: pid_path)
+      end
+
+      def set_defaults
+        @interval ||= 10
+        @verbose  ||= false
+      end
 
-    def print_help
-      puts <<-EOF
-heartbeat [OPTION]
+      def parse_args!
+        opts = GetoptLong.new(['--help', '-h', GetoptLong::NO_ARGUMENT],
+                              ['--interval', '-i', GetoptLong::REQUIRED_ARGUMENT],
+                              ['--verbose', '-v', GetoptLong::NO_ARGUMENT])
+        @interval = nil
+        @verboes  = nil
+        opts.each do |opt, arg|
+          case opt
+          when '--help'
+            print_help
+          when '--interval'
+            @interval = arg
+          when '--verbose'
+            @verbose = true
+          end
+        end
+        @command = ARGV.shift
+        return if supported_commands?(@command)
+        raise UnsupportedCommand, Rainbow('Unsupported command detected, ').red + Rainbow(@command).green
+      end
 
---help, -h:
-   show help
+      def supported_commands?(cmd)
+        cmd.nil? || %w[stop start].include?(cmd)
+      end
 
---interval <interval>, -i <interval>:
-   interval, e.g: 10 (in seconds)
+      def print_details
+        return unless @verbose
+        table = Terminal::Table.new do |t|
+          t << [Rainbow('verbose').green, Rainbow(@verbose).green]
+          t.add_row [Rainbow('interval').green, Rainbow(@interval).green]
+          t.add_row [Rainbow('command').green, Rainbow(@command).green]
+        end
+        puts table
+      end
+
+      def print_error(msg)
+        puts Rainbow(msg).red
+      end
+
+      def print_help
+        puts <<~EOF
+          heartbeat [OPTION]
+           --help, -h:
+             show help
+           --interval [interval], -i [interval]:
+             interval, e.g: 10 (in seconds)
 
       EOF
-	end
+      end
+    end
   end
 end

data/lib/heart_top/plugin/base.rb

@@ -1,9 +1,15 @@
-class HeartTop::Plugin::Base
-  class NotImplementedError < StandardError; end
+# frozen_string_literal: true
 
-  class << self
-    def ping
-      raise NotImplementedError.new "`##{__method__}` must be implemented in subclass"
+# Base Plugin class
+# Inherit this class if you adding a new plugin
+module HeartTop
+  module Plugin
+    class Base
+      class NotImplementedError < StandardError; end
+
+      def ping
+        raise NotImplementedError, "`##{__method__}` must be implemented in subclass"
+      end
     end
   end
 end

data/lib/heart_top/plugin/slack.rb

@@ -1,11 +1,31 @@
+# frozen_string_literal: true
+
+require 'heart_top/plugin/base'
+require 'singleton'
+require 'json'
+
 module HeartTop
   module Plugin
-    class Slack
-      class << self
-        def ping
-          puts 'test'
-          `curl -X POST --data-urlencode 'payload={"channel": "#hearttop", "username": "hearttop", "text": "This is posted to #hearttop and comes from a bot named hearttop.", "icon_emoji": ":ghost:"}' https://hooks.slack.com/services/<key>`
-        end
+    class Slack < Base
+      include Singleton
+
+      def ping
+        `curl -X POST --data-urlencode 'payload=#{payload}' #{webhook_url}`
+      end
+
+      private
+
+      def payload
+        {
+          channel: '#hearttop',
+          username: 'hearttop',
+          text: 'This is posted to #hearttop and comes from a bot named hearttop.',
+          icon_emoji: ':ghost:'
+        }.to_json.to_s
+      end
+
+      def webhook_url
+        ENV['SLACK_WEBHOOK_URL']
       end
     end
   end

data/lib/heart_top/plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HeartTop
   module Plugin
   end

data/lib/heart_top/schedule.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 every 1.minute do
-  rake "fave:generate_weekly_statements"
+  rake 'fave:generate_weekly_statements'
 end

data/lib/heart_top/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HeartTop
-  VERSION = "0.1.1"
+  VERSION = '0.2.0'
 end

data/lib/heart_top.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'heart_top/version'
 require 'heart_top/cli'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heart_top
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Faizal Zakaria
@@ -52,48 +52,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: dante
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.2'
 description: Have you ever go to free space, coffee shops or some random place to
   work, and you need to to toilet for pee, or big business? Then worried what would
   happen to your laptop? This tool could be the solution
@@ -108,6 +122,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -146,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: HeartTop pings the heartbeat of your laptop every N seconds