prb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97fa1172495612ccf5109e932970c74bdaf02690e9399f7da5a451f41598cfdf
-  data.tar.gz: 1df513efca5f84ac516121e0f720c1522474eb97581a390777ad37786e6caf98
+  metadata.gz: d09ffeecc26a41b306564b20a9e9acc62d5cbbfd9b03a16684ae0204f289717e
+  data.tar.gz: 0d6615043f85ff16ab3f4da9c5e2c5fa17525d16c6425b32d210898084683680
 SHA512:
-  metadata.gz: 4c3f24a6477fcca54805d9ed7a799a45f97e2afdf1007882131045f796b4ae9373b9af293fc0a8831bb2623e8398543150d6c7f32d9f03e837bd6787df19c96f
-  data.tar.gz: a0995f9549574d236c49dfd5f99f0c927c61de46c0841d4e34dbd2c9b764dddc5311f18d391a50def038ebec010aefa596a0cbb312cd7b7883fb3ea1e29b5f2e
+  metadata.gz: d5c9433e04646ea3467add2f8915cdb2ccd6c2ecb8a1dfcd6118a46f42593b0db22ab0a210316b90de478a38939a401b9e80fabbe602c9dd20c49e2036fd58cd
+  data.tar.gz: 8836c99454be9f1cbaf3a1f63c1104c3437ed350b5db9abe656fc417ff2976be188052e1b4194f349851588b9e17e479f5396350a77da42c2f925d28d627a21b

data/Gemfile.lock

@@ -1,14 +1,19 @@
 PATH
   remote: .
   specs:
-    prb (0.1.0)
-      optimist
+    prb (0.2.0)
+      optimist (~> 3.0)
+      sinatra (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.3)
+    mustermann (1.0.3)
     optimist (3.0.0)
+    rack (2.0.7)
+    rack-protection (2.0.7)
+      rack
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -23,6 +28,12 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    sinatra (2.0.7)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.7)
+      tilt (~> 2.0)
+    tilt (2.0.10)
 
 PLATFORMS
   ruby
@@ -34,4 +45,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.0.1
+   2.0.2

data/README.md

@@ -1,7 +1,7 @@
 # Prb
 
-`prb` is a light-weight timer service written in Ruby for the pomodoro
-technique.
+Prb is a light-weight HTTP service written in Ruby for controlling a pomodoro
+timer.
 
 ## Installation
 
@@ -11,24 +11,40 @@ Install the gem
 
 ## Usage
 
+The promodoro timer can be started using `prb start -d` where `-d` will
+run the process in the background.
+
+```
+prb start -d
+```
+
+Options can be passed to configure the timer. By default, there are 4 pomodoro's
+each taking 25 minutes to complete. You can override this behaviour using the
+following command:
+
+```
+prb start -d --pomodoros=4 --timer=25
 ```
-prb v0.1.0 - Pomodoro timer service
 
-Usage:
-  prb [COMMAND] [SUB_COMMAND]
+After starting the service you can query the timers status over HTTP using
+`curl`:
 
-Options:
-  -d, --daemonize    Start the service in the background
+```
+curl http://localhost:3838/status
+
+{
+    "running" true,
+    "completed": 0, # completed pomodoros
+    "remaining": 4, # remaining pomodoros
+    "time_remaining": 440
+}
+```
 
-Commands:
-  start      Start pomodoro service
-  stop       Stop pomodoro service
-  status     Print status of pomodoro service
-  skip       Skip the current timer
-  reset      Reset the current timer
-  pause      Pause the current timer
-  -v, --version      Print version and exit
-  -h, --help         Show this message
+After each pomodoro the timer will stop. The timer can be resumed
+and the next pomodoro started by using `prb resume` or by `curl` request:
+
+```
+curl http://localhost:3838/resume
 ```
 
 ## Development

data/exe/prb

@@ -1,31 +1,42 @@
 #!/usr/bin/env ruby
 
 require "optimist"
+require "webrick"
 require "bundler/setup"
 require "prb"
 
 COMMAND_MAP = {
   'start' => 'Start pomodoro service',
-  'stop' => 'Stop pomodoro service',
-  'status' => 'Print status of pomodoro service',
-  'skip' => 'Skip the current timer',
-  'reset' => 'Reset the current timer',
-  'pause' => 'Pause the current timer'
+  'resume' => 'Resume pomodoro timer',
+  'stop' => 'Stop pomodoro service'
 }
 
-opts = Optimist::options do
+global_opts = Optimist::options do
   version "prb v#{Prb::VERSION}"
   banner "prb v#{Prb::VERSION} - Pomodoro timer service\n \n"
   banner "Usage:"
-  banner "  prb [COMMAND] [SUB_COMMAND]\n \n"
-  banner "Options:"
-  opt :daemonize, 'Start the service in the background', short: '-d'
+  banner "  prb [COMMAND] [SUB_COMMAND]\n"
   banner "\nCommands:"
   COMMAND_MAP.each { |cmd, desc| banner format("  %-10s %s", cmd, desc)  }
+
+  stop_on COMMAND_MAP.keys
 end
 
 commands = COMMAND_MAP.keys & ARGV
 cmd = commands.first
+opts = {}
+
+case cmd
+when "start"
+  opts = Optimist::options do
+    opt :pomodoros, "Number of pomodoros", default: 4
+    opt :timer, "The time in minutes for the timer", default: 25
+    opt :port, "The port to run the pomodoro HTTP server", default: 3838
+    opt :daemonize, 'Start the service in the background', short: '-d'
+  end
+end
+
+opts = opts.merge(global_opts)
 
 if COMMAND_MAP.keys.include?(cmd)
   Prb::CommandRunner.new(opts).send(cmd)

data/lib/prb.rb

@@ -1,4 +1,10 @@
+require 'json'
+require 'net/http'
+require 'rack'
+require 'rack/server'
+
 require_relative "prb/version"
+require_relative "prb/opts"
 require_relative "prb/timer"
 require_relative "prb/timer_control"
 require_relative "prb/server"

data/lib/prb/command_runner.rb

@@ -1,57 +1,51 @@
 module Prb
   class CommandRunner
     def initialize(opts)
-      @opts = opts
+      @opts = Opts.new(opts)
     end
 
     def start
-      if Prb::Server.running?
+      if running?(@opts.port)
         puts "A prb server is already running."
         exit(1)
       end
 
-      Process.daemon() if @opts[:daemonize]
+      Process.daemon() if @opts.daemonize?
 
-      Prb::Server.new.start
+      app = Prb::Server.new(@opts)
+      Rack::Server.start(
+        app: app,
+        Port: @opts.port
+      )
     end
 
-    def status
-      response = send_command('STATUS')
-      puts response
-    end
-
-    def skip
-      send_command('SKIP')
-    end
-
-    def pause
-      send_command('PAUSE')
-    end
-
-    def reset
-      send_command('RESET')
+    def resume
+      send_request('resume')
     end
 
     def stop
-      send_command('QUIT')
+      send_request('stop')
     end
 
     private
 
-    def send_command(cmd)
+    def send_request(endpoint)
+      uri = URI.parse("http://0.0.0.0:#{@opts.port}/#{endpoint}")
+      Net::HTTP.get_response(uri)
+    rescue
+      nil
+    end
+
+    def running?(port)
       Timeout::timeout(1) do
         begin
-          s = TCPSocket.new('127.0.0.1', PRB_PORT)
-          s.puts(cmd)
-          response = s.gets.chomp
+          s = TCPSocket.new('0.0.0.0', port)
           s.close
-          return response
+          return true
         rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
-          puts "A prb server is not running"
-          exit(1)
+          return false
         end
       end
     end
   end
-
 end

data/lib/prb/opts.rb

@@ -0,0 +1,16 @@
+module Prb
+  class Opts
+    attr_reader :pomodoros, :timer, :port
+
+    def initialize(opts)
+      @pomodoros = opts[:pomodoros].to_i
+      @timer = opts[:timer].to_i
+      @daemonize = opts[:daemonize]
+      @port = (opts[:port] || 3838).to_i
+    end
+
+    def daemonize?
+      !!@daemonize
+    end
+  end
+end

data/lib/prb/server.rb

@@ -1,76 +1,40 @@
-require 'socket'
 require 'timeout'
+require 'sinatra/base'
 
 module Prb
-  PRB_PORT = 3838
+  class Server < Sinatra::Base
+    def initialize(opts)
+      puts <<~MSG
+      Starting pomodoro service...
 
-  class Server
-    def initialize
-      @controller = TimerControl.new
-    end
-
-    def start
-      @controller.start
-
-      server = TCPServer.open('127.0.0.1', PRB_PORT)
-      puts "Server listening on #{PRB_PORT}"
+      Number of pomodoros: #{opts.pomodoros} pomodoro(s)
+      Pomodoro timer:      #{opts.timer} minute(s)
 
-      while true
-        Thread.start(server.accept) do |socket|
-          while cmd = socket.gets.chomp
-            puts "RECV: #{cmd}"
+      MSG
 
-            output = "OK"
-            case cmd
-            when 'STATUS'
-              output = status_line
-            when 'SKIP'
-              @controller.toggle
-            when 'RESET'
-              @controller.reset
-            when 'PAUSE'
-              @controller.pause
-            when 'QUIT'
-              socket.puts "OK"
-              exit(0)
-            else
-              puts "ERR: #{cmd} not a command"
-              output = "ERR: #{cmd} not a command"
-            end
-
-            socket.puts output
-          end
+      @controller = TimerControl.new(opts)
+      @controller.start
 
-          socket.close
-        end
-      end
+      super
+    end
 
-      server.close
+    get '/status' do
+      content_type :json
+      @controller.render_status
     end
 
-    def self.running?
-      Timeout::timeout(1) do
-        begin
-          s = TCPSocket.new('127.0.0.1', PRB_PORT)
-          s.close
-          return true
-        rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
-          return false
-        end
-      end
+    get '/reset' do
+      @controller.reset
+      status 200
     end
 
-    private
+    get '/resume' do
+      @controller.resume
+      status 200
+    end
 
-    def status_line
-      status = ""
-      status << @controller.timer.render
-      status << ","
-      status << "WORKING" if @controller.is_working?
-      status << "BREAK" if !@controller.is_working?
-      status << ",PAUSED" if @controller.paused?
-      status << ",RUNNING" if !@controller.paused?
-      status
+    get '/stop' do
+      Process.kill("INT", Process.pid)
     end
   end
 end

data/lib/prb/timer.rb

@@ -1,41 +1,57 @@
 module Prb
   class Timer
-    def initialize(minutes)
+    attr_reader :pomodoros, :seconds, :paused, :completed
+
+    WORKING = 1
+    PAUSED = 2
+
+    def initialize(opts)
+      @opts = opts
+
       @paused = false
-      set_timer(minutes)
-    end
+      @pomodoros = opts.pomodoros
 
-    def set_timer(minutes)
-      @_seconds = minutes * 60
-      @seconds = @_seconds
+      # set pomodoro timer
+      set_timer(@opts.timer)
     end
 
     def tick
-      sleep 1
-      @seconds -= 1 unless @paused or finished?
-    end
+      return if completed? or paused? 
 
-    def finished?
-      @seconds == 0
+      if @seconds == 0
+        if @paused == false
+          @pomodoros -= 1
+          @paused = true
+        end
+      else
+        @seconds -= 1
+      end
     end
 
-    def reset
-      @seconds = @_seconds
+    def resume
+      @paused = false
+      set_timer(@opts.timer)
     end
 
-    def pause
-      @paused = !@paused
+    def reset
+      @paused = false
+      @pomodoros = @opts.pomodoros
+      set_timer(@opts.timer)
     end
 
     def paused?
       @paused
     end
 
-    def render
-      min = (@seconds / 60) % 60
-      sec = (@seconds % 60)
+    private
+
+    def set_timer(minutes)
+      @_seconds = minutes * 60
+      @seconds = @_seconds
+    end
 
-      format("%02d:%02d", min, sec)
+    def completed?
+      @pomodoros == 0
     end
   end
 end

data/lib/prb/timer_control.rb

@@ -1,45 +1,36 @@
 module Prb
   class TimerControl
-    WORK_MINUTES = 25
-    BREAK_MINUTES = 5
-
     attr_reader :timer
 
-    def initialize
-      @timer = Timer.new(WORK_MINUTES)
-      @is_working = true
+    def initialize(opts)
+      @opts = opts
+      @timer = Timer.new(@opts)
     end
 
     def start
       Thread.new do
         loop do
+          sleep 1
           @timer.tick
-          toggle if @timer.finished?
         end
       end
     end
 
-    def reset
-      @timer.reset
-    end
-
-    def pause
-      @timer.pause
+    def render_status
+      {
+        running: !@timer.paused?,
+        completed: @opts.pomodoros - @timer.pomodoros,
+        remaining: @timer.pomodoros,
+        time_remaining: @timer.seconds,
+      }.to_json
     end
 
-    def paused?
-      @timer.paused?
-    end
-
-    def is_working?
-      @is_working
+    def reset
+      @timer.reset
     end
 
-    def toggle
-      @is_working = !@is_working
-      @timer.set_timer(@is_working ?
-                      WORK_MINUTES : BREAK_MINUTES)
-      @timer.pause unless @timer.paused?
+    def resume
+      @timer.resume
     end
   end
 end

data/lib/prb/version.rb

@@ -1,3 +1,3 @@
 module Prb
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/prb.gemspec

@@ -36,7 +36,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "optimist"
+  spec.add_dependency "optimist", "~> 3.0"
+  spec.add_dependency "sinatra", "~> 2.0"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: prb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Richard Ramsden
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-21 00:00:00.000000000 Z
+date: 2019-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: optimist
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +100,7 @@ files:
 - exe/prb
 - lib/prb.rb
 - lib/prb/command_runner.rb
+- lib/prb/opts.rb
 - lib/prb/server.rb
 - lib/prb/timer.rb
 - lib/prb/timer_control.rb