signaly-notify 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13a9873131db788193be40e2c480a033c8a065e0
+  data.tar.gz: ba7fef24bbc5bce843e84aeaa323ef86a6f608e5
+SHA512:
+  metadata.gz: 33176d90d86058ca014e1109fe2d8566c426e3350751161eaed98bf66a47af72b0b101c86eacfe9d1328284556e0a1426b6175c1b923a857642fb0c1121f0b25
+  data.tar.gz: 7c864244d36b727f8fe02f846d8642db84c4deeda7f342aa34facf4dbd8d9713fc4a65115da3b91b606467b7a358677d3560380f281fa409aa4bb9711a121068

data/bin/signaly-notify.rb

@@ -0,0 +1,345 @@
+#!/bin/env ruby
+
+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, 
+                      :notification_showtime,
+                      :debug_output,
+                      :login,
+                      :password)
+
+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,
+# remind me after X seconds
+defaults.remind_after = 60*5
+# for how long time the notification shows up
+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
+end
+
+class SignalyStatus < Struct.new(:pm, :notifications, :invitations)
+
+  def initialize(pm=0, notifications=0, invitations=0)
+    super(pm, notifications, invitations)
+  end
+
+  def is_there_anything?
+    self.each_pair {|k,v| return true if v > 0 }
+    return false
+  end
+
+  # utility function to handle the statuses:
+
+  def changed?(old_status, item)
+    (old_status == nil && self[item] > 0) ||
+      (old_status != nil && self[item] != old_status[item])
+  end
+end
+
+class SignalyChecker
+  # interaction with signaly.cz
+
+  def initialize(username, password, dbg_print=false)
+    @username = username
+    @password = password
+
+    @agent = Mechanize.new
+
+    @dbg_print_pages = dbg_print # print raw html of all request results?
+
+    login
+  end
+
+  USERMENU_XPATH = ".//div[contains(@class, 'section-usermenu')]"
+
+  # takes user name and password; returns a page (logged-in) or throws
+  # exception
+  def login
+    page = @agent.get('https://www.signaly.cz/')
+    debug_page_print "front page", page
+
+    login_form = page.form_with(:id => 'frm-loginForm')
+    unless login_form
+      raise "Login form not found on the index page!"
+    end
+    login_form['name'] = @username
+    login_form['password'] = @password
+
+    page = @agent.submit(login_form)
+    debug_page_print "first logged in", page
+
+    errors = page.search(".//div[@class='alert alert-error']")
+    if errors.size > 0 then
+      msg = ''
+      errors.each {|e| msg += e.text.strip+"\n" }
+      raise "Login to signaly.cz failed: "+msg
+    end
+
+    usermenu = page.search(USERMENU_XPATH)
+    if usermenu.empty? then
+      raise "User-menu not found. Login failed or signaly.cz UI changed again."
+    end
+
+    return page
+  end
+
+  def user_status
+    status = SignalyStatus.new
+    page = @agent.get('https://www.signaly.cz/')
+    debug_page_print "user main page", page
+    
+    menu = page.search(USERMENU_XPATH)
+
+    pm = menu.search(".//a[@href='/vzkazy']")
+    status[:pm] = find_num(pm.text)
+
+    notif = menu.search(".//a[@href='/ohlasky']")
+    status[:notifications] = find_num(notif.text)
+
+    inv = menu.search(".//a[@href='/vyzvy']")
+    if inv then
+      status[:invitations] = find_num(inv.text)
+    end
+
+    return status
+  end
+
+  private
+
+  def debug_page_print(title, page)
+    return if ! @dbg_print_pages
+
+    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
+  end
+end
+
+class SignalyStatusOutputter
+  def initialize(config)
+    @config = config
+  end
+
+  def output(new_status, old_status)
+  end
+end
+
+class ConsoleOutputter < SignalyStatusOutputter
+  def output(new_status, old_status)
+    print_line new_status, old_status
+    set_console_title new_status
+  end
+
+  private
+
+  def print_line(new_status, old_status)
+    t = Time.now
+
+    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)
+    end
+    puts "  invitations: "+is
+  end
+
+  # doesn't work....
+  def set_console_title(status)
+    t = "signaly-notify: #{status[:pm]}/#{status[:notifications]}"
+    `echo -ne "\\033]0;#{t}\\007"`
+  end
+end
+
+class LibNotifyOutputter < SignalyStatusOutputter
+  def output(new_status, old_status)
+    send_notification new_status
+  end
+
+  private
+
+  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}"
+
+    Libnotify.show(:body => text, :summary => "signaly.cz", :timeout => @config.notification_showtime)
+  end
+end
+
+
+############################################# main
+
+# 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
+
+# process options
+optparse = OptionParser.new do |opts|
+  opts.on "-u", "--user NAME", "user name used to log in" do |n|
+    config.login = n
+  end
+
+  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
+
+  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
+
+  opts.on "-d", "--debug", "print debugging information to STDERR" do
+    config.debug_output = true
+  end
+
+  opts.on "-h", "--help", "print this help" do
+    puts opts
+    exit 0
+  end
+
+  opts.on "-c", "--config FILE", "configuration file" do |f|
+    config_file = f
+  end
+end
+optparse.parse!
+
+if config_file then
+  config_layers << YAML.load(File.open(config_file))
+end
+
+config = merge_structs(*config_layers)
+
+unless ARGV.empty? 
+  puts "Warning: unused commandline arguments: "+ARGV.join(', ')
+end
+
+# ask the user for missing essential information
+cliio = HighLine.new
+
+if !config.login then
+  config.login = cliio.ask("login: ")
+end
+
+if !config.password then
+  config.password = cliio.ask("password: ") {|q| q.echo = '*' }
+end
+
+checker = SignalyChecker.new config.login, config.password, config.debug_output
+
+old_status = status = nil
+last_reminder = 0
+
+co = ConsoleOutputter.new config
+lno = LibNotifyOutputter.new config
+
+loop do
+  old_status = status
+
+  begin
+    status = checker.user_status
+  rescue Exception => e
+    Libnotify.show(:body => e.message, 
+                   :summary => "signaly.cz: ERROR", 
+                   :timeout => 20)
+    sleep 21
+    raise
+  end
+
+  # print each update to the console:
+  co.output status, old_status
+
+  # send a notification only if there is something interesting:
+
+  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
+
+  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
+  end
+
+  sleep config.sleep_seconds
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: signaly-notify
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Jakub Pavlík
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  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'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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'
+- !ruby/object:Gem::Dependency
+  name: highline
+  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'
+- !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'
+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
+  something new happens.\nCurrently it only detects pending private messages and notifications."
+email: jkb.pavlik@gmail.com
+executables:
+- signaly-notify.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/signaly-notify.rb
+homepage: http://github.com/igneus/signaly-notify
+licenses:
+- LGPL-3.0
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: notification script for signaly.cz (Czech christian social network)
+test_files: []