signaly-notify 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13a9873131db788193be40e2c480a033c8a065e0
-  data.tar.gz: ba7fef24bbc5bce843e84aeaa323ef86a6f608e5
+  metadata.gz: d504ba72d7f41e9ae2d5fecf6ed2d6ac7a821525
+  data.tar.gz: d669974e5f5e67cc144d2ad216897284a50bc5c2
 SHA512:
-  metadata.gz: 33176d90d86058ca014e1109fe2d8566c426e3350751161eaed98bf66a47af72b0b101c86eacfe9d1328284556e0a1426b6175c1b923a857642fb0c1121f0b25
-  data.tar.gz: 7c864244d36b727f8fe02f846d8642db84c4deeda7f342aa34facf4dbd8d9713fc4a65115da3b91b606467b7a358677d3560380f281fa409aa4bb9711a121068
+  metadata.gz: f8b1aed68273983cc7c0b862829fc3c4d2960c6c71118271f398310425e97a404113fa4b18fb55415680adc16e85b0b2d8ba0f172581c7d92afc71877815db55
+  data.tar.gz: 024beb8fc12147e2a095839dbcd2aa68631f621674927d1456c33e83bfa90d2366f8b7b40d5fdfb41c27bffdcaa1aead313af0e152b6b8dc491940a1b66861d7

data/bin/signaly-notify.rb

@@ -3,42 +3,33 @@
 require 'mechanize' # interaction with websites
 require 'colorize' # colorful console output
 require 'highline' # automating some tasks of the cli user interaction
-require 'libnotify' # visual notification
 require 'optparse'
 require 'yaml'
 
-SNConfig = Struct.new(:sleep_seconds, 
-                      :remind_after, 
+# optional gems for visual notifications
+begin
+  require 'libnotify'
+rescue LoadError
+end
+
+begin
+  require 'ruby-growl'
+rescue LoadError
+end
+
+SNConfig = Struct.new(:sleep_seconds, # between checks
+                      :remind_after, # the first notification
                       :notification_showtime,
                       :debug_output,
                       :login,
-                      :password)
+                      :password,
+                      :url, # of the checked page
+                      :skip_login,
+                      :config_file,
+                      :console_only,
+                      :notify)
 
-config_layers = []
-
-config = SNConfig.new
 defaults = SNConfig.new
-
-config_layers << defaults
-config_layers << config
-
-# merges the config structs so that the last one
-# in the argument list has the highest priority and value nil is considered
-# empty
-def merge_structs(*structs)
-  merged = structs.first.dup
-
-  merged.each_pair do |key, value|
-    k = key.to_s # a sym normally; but we also want to merge a normal Hash received from Yaml
-    structs.each do |s|
-      if s[k] != nil then
-        merged[k] = s[k]
-      end
-    end
-  end
-end
-
-# set config defaults:
 # how many seconds between two checks of the site
 defaults.sleep_seconds = 60
 # if there is some pending content and I don't look at it,
@@ -48,20 +39,14 @@ defaults.remind_after = 60*5
 defaults.notification_showtime = 10
 defaults.debug_output = false
 defaults.password = nil
-
-
-# finds the first integer in the string and returns it
-# or returns 0
-def find_num(str)
-  m = str.match /\d+/
-
-  unless m
-    return 0
-  end
-
-  return m[0].to_i
+# use first available visual notification engine
+if defined? Libnotify
+  defaults.notify = :libnotify
+elsif defined? Growl
+  defaults.notify = :growl
 end
 
+# how many PMs, notifications, invitations a user has at a time
 class SignalyStatus < Struct.new(:pm, :notifications, :invitations)
 
   def initialize(pm=0, notifications=0, invitations=0)
@@ -73,26 +58,40 @@ class SignalyStatus < Struct.new(:pm, :notifications, :invitations)
     return false
   end
 
-  # utility function to handle the statuses:
+  # does self have anything new compared with other?
+  def >(other)
+    if other.nil?
+      return true
+    end
 
-  def changed?(old_status, item)
-    (old_status == nil && self[item] > 0) ||
-      (old_status != nil && self[item] != old_status[item])
+    [:pm, :notifications, :invitations].each do |prop|
+      if send(prop) > other.send(prop) then
+        return true
+      end
+    end
+
+    return false
+  end
+
+  # is there any change between old_status and self in property prop?
+  def changed?(old_status, prop)
+    (old_status == nil && self[prop] > 0) ||
+      (old_status != nil && self[prop] != old_status[prop])
   end
 end
 
+# interaction with signaly.cz
 class SignalyChecker
-  # interaction with signaly.cz
 
-  def initialize(username, password, dbg_print=false)
-    @username = username
-    @password = password
+  def initialize(config)
+    @username = config.login
+    @password = config.password
 
     @agent = Mechanize.new
 
-    @dbg_print_pages = dbg_print # print raw html of all request results?
+    @dbg_print_pages = config.debug_output || false # print raw html of all request results?
 
-    login
+    @checked_page = config.url || 'https://www.signaly.cz/'
   end
 
   USERMENU_XPATH = ".//div[contains(@class, 'section-usermenu')]"
@@ -100,7 +99,7 @@ class SignalyChecker
   # takes user name and password; returns a page (logged-in) or throws
   # exception
   def login
-    page = @agent.get('https://www.signaly.cz/')
+    page = @agent.get(@checked_page)
     debug_page_print "front page", page
 
     login_form = page.form_with(:id => 'frm-loginForm')
@@ -130,9 +129,9 @@ class SignalyChecker
 
   def user_status
     status = SignalyStatus.new
-    page = @agent.get('https://www.signaly.cz/')
+    page = @agent.get(@checked_page)
     debug_page_print "user main page", page
-    
+
     menu = page.search(USERMENU_XPATH)
 
     pm = menu.search(".//a[@href='/vzkazy']")
@@ -154,14 +153,42 @@ class SignalyChecker
   def debug_page_print(title, page)
     return if ! @dbg_print_pages
 
-    STDERR.puts 
-    STDERR.puts(("# "+title).colorize(:yellow))
+    STDERR.puts
+    STDERR.puts ("# "+title).colorize(:yellow)
     STDERR.puts
     STDERR.puts page.search(".//div[@class='navbar navbar-fixed-top section-header']")
     STDERR.puts
-    STDERR.puts("-" * 60)
+    STDERR.puts "-" * 60
     STDERR.puts
   end
+
+  # finds the first integer in the string and returns it
+  def find_num(str, default=0)
+    m = str.match /\d+/
+    return m ? m[0].to_i : default
+  end
+end
+
+# dispatches events to observers - subscribed notifiers
+class Notifier
+  def initialize
+    @outputters = {}
+  end
+
+  def add_outputter(outputter, *events)
+    events.each do |event|
+      @outputters[event] ||= []
+      @outputters[event] << outputter
+    end
+    self
+  end
+
+  def emit(event, *args)
+    if @outputters[event]
+      @outputters[event].each {|o| o.output *args }
+    end
+    self
+  end
 end
 
 class SignalyStatusOutputter
@@ -187,23 +214,14 @@ class ConsoleOutputter < SignalyStatusOutputter
     puts # start on a new line
     print t.strftime("%H:%M:%S")
 
-    ms = new_status[:pm].to_s
-    if new_status.changed?(old_status, :pm) then
-      ms = ms.colorize(:red)
-    end
-    print "  messages: "+ms
-
-    ns = new_status[:notifications].to_s
-    if new_status.changed?(old_status, :notifications) then
-      ns = ns.colorize(:red) 
-    end
-    print "  notifications: "+ns
-
-    is = new_status[:invitations].to_s
-    if new_status.changed?(old_status, :invitations) then
-      is = is.colorize(:red)
+    [:pm, :notifications, :invitations].each do |what|
+      num = new_status[what].to_s
+      if new_status.changed?(old_status, what) then
+        num = num.colorize(:red)
+      end
+      print "  #{what}: #{num}"
     end
-    puts "  invitations: "+is
+    puts
   end
 
   # doesn't work....
@@ -215,131 +233,207 @@ end
 
 class LibNotifyOutputter < SignalyStatusOutputter
   def output(new_status, old_status)
-    send_notification new_status
-  end
+    text = [:pm, :notifications, :invitations].collect do |what|
+      "#{what}: #{new_status[what]}"
+    end.join "\n"
 
-  private
+    Libnotify.show(:body => text, :summary => "signaly.cz", :timeout => @config.notification_showtime)
+  end
+end
 
-  def send_notification(status)
-    ms = status[:pm].to_s
-    ns = status[:notifications].to_s
-    is = status[:invitations].to_s
-    text = "pm: #{ms}\nnotifications: #{ns}\ninvitations: #{is}"
+class GrowlOutputter < SignalyStatusOutputter
+  def output(new_status, old_status)
+    text = [:pm, :notifications, :invitations].collect do |what|
+      "#{what}: #{new_status[what]}"
+    end.join "\n"
 
-    Libnotify.show(:body => text, :summary => "signaly.cz", :timeout => @config.notification_showtime)
+    notif = Growl.new 'localhost', 'ruby-growl', 'GNTP'
+    notif.notify('signaly.cz', 'signaly.cz', text)
   end
 end
 
+class SignalyNotifyApp
 
-############################################# main
+  DEFAULT_CONFIG_PATH = ".config/signaly-notify/config.yaml"
 
-# find default config
-config_file = nil
-default_config_path = "#{ENV['HOME']}/.config/signaly-notify/config.yaml"
-if default_config_path then
-  config_file = default_config_path
-end
+  attr_accessor :default_config
 
-# process options
-optparse = OptionParser.new do |opts|
-  opts.on "-u", "--user NAME", "user name used to log in" do |n|
-    config.login = n
-  end
+  def call(argv)
+    options = process_options(argv)
+    config = merge_structs(
+      @default_config,
+      config_file(options.config_file),
+      options
+    )
+    ask_config config
 
-  opts.on "-p", "--password WORD", "user's password" do |p|
-    config.password = p
-  end
-  
-  opts.separator "If you don't provide any of the options above, "\
-  "the program will ask you to type the name and/or password on its start. "\
-  "(And especially "\
-  "for the password it's probably a bit safer to type it this way than "\
-  "to type it on the commandline.)\n\n"
-
-  opts.on "-s", "--sleep SECS", Integer, "how many seconds to sleep between two checks (default is #{config.sleep_seconds})" do |s|
-    config.sleep_seconds = s
-  end
+    notifier = Notifier.new
+    prepare_outputters config, notifier
 
-  opts.on "-r", "--remind SECS", Integer, "if I don't bother about the contents I recieved a notification about, remind me after X seconds (default is #{config.remind_after}; set to 0 to disable)" do |s|
-    config.remind_after = s
+    check_loop config, notifier
   end
 
-  opts.on "-d", "--debug", "print debugging information to STDERR" do
-    config.debug_output = true
-  end
+  private
 
-  opts.on "-h", "--help", "print this help" do
-    puts opts
-    exit 0
-  end
+  # load configuration from config file
+  def config_file(path=nil)
+    path ||= File.join ENV['HOME'], DEFAULT_CONFIG_PATH
 
-  opts.on "-c", "--config FILE", "configuration file" do |f|
-    config_file = f
+    if File.exist? path then
+      cfg = YAML.load(File.open(path))
+      # symbolize keys
+      cfg = cfg.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+      return cfg
+    end
+
+    return nil
   end
-end
-optparse.parse!
 
-if config_file then
-  config_layers << YAML.load(File.open(config_file))
-end
+  def process_options(argv)
+    config = SNConfig.new
+    optparse = OptionParser.new do |opts|
+      opts.on "-u", "--user NAME", "user name used to log in" do |n|
+        config.login = n
+      end
 
-config = merge_structs(*config_layers)
+      opts.on "-p", "--password WORD", "user's password" do |p|
+        config.password = p
+      end
 
-unless ARGV.empty? 
-  puts "Warning: unused commandline arguments: "+ARGV.join(', ')
-end
+      opts.separator "If you don't provide any of the options above, "\
+                     "the program will ask you to type the name and/or password on its start. "\
+                     "(And especially "\
+                     "for the password it's probably a bit safer to type it this way than "\
+                     "to type it on the commandline.)\n\n"
 
-# ask the user for missing essential information
-cliio = HighLine.new
+      opts.on "-s", "--sleep SECS", Integer, "how many seconds to sleep between two checks (default is #{config.sleep_seconds})" do |s|
+        config.sleep_seconds = s
+      end
 
-if !config.login then
-  config.login = cliio.ask("login: ")
-end
+      opts.on "-r", "--remind SECS", Integer, "if I don't bother about the contents I recieved a notification about, remind me after X seconds (default is #{config.remind_after}; set to 0 to disable)" do |s|
+        config.remind_after = s
+      end
 
-if !config.password then
-  config.password = cliio.ask("password: ") {|q| q.echo = '*' }
-end
+      opts.on "--notify NOTIFIER", "choose visual notification engine (possible values are 'libnotify' and 'growl')" do |s|
+        config.notify = s.to_sym
+      end
+
+      opts.on "--console-only", "don't display any visual notifications" do
+        config.console_only = true
+      end
+
+      opts.on "-d", "--debug", "print debugging information to STDERR" do
+        config.debug_output = true
+      end
+
+      opts.on "--url URL", "check URL different from the default (for developmeng)" do |s|
+        config.url = s
+      end
+
+      opts.on "--skip-login", "don't login (for development)" do
+        config.skip_login = true
+      end
 
-checker = SignalyChecker.new config.login, config.password, config.debug_output
+      opts.on "-h", "--help", "print this help" do
+        puts opts
+        exit 0
+      end
+
+      opts.on "-c", "--config FILE", "configuration file" do |f|
+        config.config_file = f
+      end
+    end
+    optparse.parse! argv
+
+
+    unless argv.empty?
+      STDERR.puts "Warning: unused commandline arguments: "+ARGV.join(', ')
+    end
+
+    return config
+  end
+
+  # ask the user for missing essential information
+  def ask_config(config)
+    cliio = HighLine.new
+    config.login ||= cliio.ask("login: ")
+    config.password ||= cliio.ask("password: ") {|q| q.echo = '*' }
+  end
+
+  # merges the config structs so that the last one
+  # in the argument list has the highest priority and value nil is considered
+  # empty
+  def merge_structs(*structs)
+    merged = structs.shift.dup
+
+    merged.each_pair do |key, value|
+      structs.each do |s|
+        next if s.nil?
+        if s[key] != nil then
+          merged[key] = s[key]
+        end
+      end
+    end
 
-old_status = status = nil
-last_reminder = 0
+    return merged
+  end
 
-co = ConsoleOutputter.new config
-lno = LibNotifyOutputter.new config
+  def prepare_outputters(config, notifier)
+    notifier.add_outputter ConsoleOutputter.new(config), :checked
 
-loop do
-  old_status = status
+    return if config.console_only
+    return unless config.notify
 
-  begin
-    status = checker.user_status
-  rescue Exception => e
-    Libnotify.show(:body => e.message, 
-                   :summary => "signaly.cz: ERROR", 
-                   :timeout => 20)
-    sleep 21
-    raise
+    case config.notify.to_sym
+    when :libnotify
+      notifier.add_outputter LibNotifyOutputter.new(config), :changed, :remind
+    when :growl
+      notifier.add_outputter GrowlOutputter.new(config), :changed, :remind
+    end
   end
 
-  # print each update to the console:
-  co.output status, old_status
+  def check_loop(config, notifier)
+    checker = SignalyChecker.new config
+    checker.login unless config.skip_login
+
+    old_status = status = nil
+    last_reminder = 0
+
+    loop do
+      old_status = status
+
+      begin
+        status = checker.user_status
+      rescue Exception, SocketError => e
+        STDERR.puts "#{e.class}: #{e.message}"
+        sleep config.sleep_seconds
+        retry
+      end
 
-  # send a notification only if there is something interesting:
+      notifier.emit :checked, status, old_status
 
-  if old_status == nil ||
-      (status[:pm] > old_status[:pm] || 
-       status[:notifications] > old_status[:notifications]) then
-    # something new
-    lno.output status, old_status
-    last_reminder = Time.now.to_i
+      if status > old_status then
+        # something new
+        notifier.emit :changed, status, old_status
+        last_reminder = Time.now.to_i
 
-  elsif config.remind_after != 0 &&
-      Time.now.to_i >= last_reminder + config.remind_after &&
-      status.is_there_anything? then
-    # nothing new, but pending content should be reminded
-    lno.output status, old_status
-    last_reminder = Time.now.to_i
+      elsif config.remind_after != 0 &&
+            Time.now.to_i >= last_reminder + config.remind_after &&
+                                             status.is_there_anything? then
+        # nothing new, but pending content should be reminded
+        notifier.emit :remind, status, old_status
+        last_reminder = Time.now.to_i
+      end
+
+      sleep config.sleep_seconds
+    end
   end
+end
+
+
 
-  sleep config.sleep_seconds
+if $0 == __FILE__ then
+  app = SignalyNotifyApp.new
+  app.default_config = defaults
+  app.call ARGV
 end

metadata

@@ -1,71 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: signaly-notify
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Jakub Pavlík
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-05 00:00:00.000000000 Z
+date: 2015-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: libnotify
-  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'
+        version: '1.7'
 description: "signaly-notify.rb is a simple script \nlogging in with your user data
   to the social network https://signaly.cz \nand notifying you - by the means of printing
   to the console \nas well as sending a visual notification using libnotify - \nwhen
@@ -88,18 +74,19 @@ 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.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: notification script for signaly.cz (Czech christian social network)
 test_files: []
+has_rdoc: