snarl-snp 0.1.1

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "snarl-snp"
+    gem.summary = %Q{Snarl Network Protocol Client. You can notify to Snarl over LAN.}
+    gem.description = %Q{Snarl Network Protocol Client. Snarl is the notification program for Windows. You can send notification messages to Snarl with SNP over LAN.}
+    gem.email = "ezookojo@gmail.com"
+    gem.homepage = "http://github.com/kitamomonga/snarl-snp"
+    gem.authors = ["kitamomonga"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "webmock"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "snarl-snp #{version}"
+  rdoc.rdoc_files.include('README.rdoc*')
+  rdoc.rdoc_files.include('GUIDE.rdoc*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/exsample/ping.rb

@@ -0,0 +1,8 @@
+#!ruby
+require 'rubygems'
+$LOAD_PATH.unshift(File.join(File.dirname(File.expand_path(__FILE__)), '/../lib/'))
+require 'snarl/snp'
+
+host = ENV['SNARL_HOST'] || ARGV[0] || '127.0.0.1'
+
+Snarl::SNP.ping(host)

data/exsample/winamp_nowplaying.rb

@@ -0,0 +1,227 @@
+#!ruby -Ks
+
+# require 'rubygems'
+$LOAD_PATH.unshift(File.join(File.dirname(File.expand_path(__FILE__)), '/../lib/'))
+require 'snarl/snp'
+
+# You may use Winamp plugin "File Runner" (gen_runner.dll)
+# http://www.geocities.jp/nanasiya3/ext.html#WA-GEN-RUNNER
+#
+# "File Runner" Command: "fullpath_rubyw_with_quote"
+# "File Runner" Parameter: "fullpath_winamp_nowplaying.rb_with_quote" quoted_params
+# quoted_params => "%artist%||%album%||%title%||%tracknumber%||%year%||%genre%||%comment%||%filename%||%index%||icon=>:album"
+# or
+# quoted_params => "%artist%||%album%||%title%||%tracknumber%||%year%||%genre%||%comment%||%filename%||%index%||icon=>c:\icon.jpg"
+# icon=>:album means icon=>"#{File.dirname(%filename%)}\#{%album%}.[jpg|gif|png|bmp]"
+# icon=>:loose means icon=>"Dir.glob(#{File.dirname(%filename%)}\**.[jpg|gif|png|bmp])[0]"
+
+# just run me, and you will get parameters infomation.
+# See WinampNowPlaying#warn_paramerter_infomation_and_exit.
+class WinampNowPlaying
+
+  class MusicData
+    WINAMPDATA_ORDER = %w(artist album title tracknumber year genre comment filename index iconinfo)
+    def initialize(data)
+      @data = data
+    end
+
+    def [](k) ; @data[k] ; end
+    def []=(k, v) ; @data[k] = v ; end
+
+    WINAMPDATA_ORDER.each do |mes|
+      eval("def #{mes} ; self['#{mes}'] ; end; def #{mes}=(v) ; self['#{mes}']=v ; end")
+    end
+    def icon_value
+      iconinfo.to_s.scan(/icon=>(.+?)\Z/).flatten[0]
+    end
+
+    def query
+      WINAMPDATA_ORDER[0..-2].map do |e|
+        s = self.__send__(e)
+        if (s.nil? || s.empty?) then '' else s end
+      end.join('||')
+    end
+
+    def to_s
+      "#{query}||icon=>#{icon_value}"
+    end
+
+    def self.parse(argv)
+      self.new(Hash[*WINAMPDATA_ORDER.zip(argv.join(" ").split(/\|\|/)).flatten])
+    end
+    def icon_mode
+      case
+      when /icon=>:album\Z/ =~ iconinfo then
+        :album
+      when /icon=>:loose\Z/ =~ iconinfo then
+        :loose
+      when /icon=>\Z|icon=>nil\Z|icon=>:default\Z/ =~ iconinfo then
+        :default
+      when iconinfo.nil? then
+        :default
+      else
+        :user
+      end
+    end
+  end
+
+  ## Winamp data "icon=>xxxx"
+  # icon=>:album
+  #     use "#{@album}.{gif,png,jpg,bmp}" ,if none, go :default
+  # icon=>:loose
+  #     use "#{@album}.{gif,png,jpg,bmp}", if none, Dir.glob(*.{gif,png,jpg,bmp})[0] , or, go :default
+  # icon=>:default
+  #     use Snarl Setting (maybe Snarl facemark)
+  # icon=>full_file_path_for_image
+  #     use filepath for reading icon(i.e, C:\icon.jpg). separators are '\' or "/"
+  # icon=>image_url
+  #     access url and use it
+  class Icon
+
+    ICON_EXTNAME = %w(gif png jpg bmp jpeg)
+
+    def initialize(d, strict = false)
+      @d = d
+      @albumdir = File.dirname(@d['filename']) #or Winamp %folder%
+      @strict = strict
+    end
+
+    def expecting_jacketimages
+      ICON_EXTNAME.map{|ext| File.join(@albumdir, "#{@d['album']}.#{ext}")}
+    end
+
+    def album_name_image
+      expecting_jacketimages.find{|path| FileTest.file?(path)}
+    end
+
+    def albumdir_entries
+      albumdir_glob = @albumdir.gsub(/\\/){'/'} + '/*'
+      Dir.glob(albumdir_glob)
+    end
+
+    def is_image?(f)
+      /#{ICON_EXTNAME.join('|')}/ =~ f
+    end
+
+    def altanative_image
+      albumdir_entries.find{|file| is_image?(file)}
+    end
+
+    def user_image
+      @d.icon_value
+    end
+
+    def icon
+      # xxxx_image actually returns nil.
+      case @d.icon_mode
+      when :album   then album_name_image || nil
+      when :loose   then album_name_image || altanative_image || nil
+      when :default then nil
+      when :user    then user_image || nil
+      end
+    end
+  end
+  
+  def initialize(host, port, &block)
+    warn_paramerter_infomation_and_exit if argv.empty?
+
+    @host = host || '127.0.0.1'
+    @port = port || 9887
+    # The following applications are registered with Snarl:
+    @app = "Winamp"
+    # Notification classes:
+    @class = "Now Playing"
+    # Message "First Line"
+    @title = "Winamp Now Playing:"
+    @text = nil
+    @icon = nil
+
+    @log_output = File.join(ENV['HOME'], 'snarl_winamp.log.txt')
+    @logger = defined?(Logger) ? Logger.new(@log_output) : nil
+    @data = MusicData.parse(argv)
+
+    yield(self) if block_given?
+  end
+
+  attr_writer :host, :app, :class, :title, :logger, :log_output, :text, :icon
+  attr_reader :data
+
+  def argv
+    ARGV
+  end
+
+  def icon
+    case
+    when %w(default system none).include?(@icon.to_s) then nil
+    when @icon.nil?                                   then Icon.new(@data).icon
+    when %w(album).include?(@icon.to_s)               then Icon.new(@data).icon
+    when @icon                                        then @icon
+    end
+  end
+
+  def text
+    # do not join with "\r\n"
+    case
+    when @text.kind_of?(Proc) then
+      res = @text.call(self)
+    when @text.kind_of?(String) then
+      res = @text
+    else
+      res = [@data.title, "#{@data.artist}/#{@data.album}"].join("\n")
+    end
+    res
+  end
+
+  def show_message
+    Snarl::SNP.open(@host, @port) do |c|
+      c.logger = @logger if @logger
+      c.register(@app)
+      c.add_class(@class)
+      c.notification(@title, text, icon, 8, @class)
+    end
+  end
+
+  def warn_paramerter_infomation_and_exit
+    require 'rbconfig'
+    warn 'You may use Winamp plugin "File Runner" (gen_runner.dll)'
+    warn 'http://www.geocities.jp/nanasiya3/ext.html#WA-GEN-RUNNER'
+    warn ''
+
+    # display path of rubyw.exe
+    if Config::CONFIG.has_key?('rubyw_install_name')
+      rubyw = File.join(Config::CONFIG['bindir'], Config::CONFIG['rubyw_install_name'])
+      warn %Q{"#{rubyw}"}
+    else
+      warn "*** rubyw is missing? ***"
+    end
+    # display where_am_i and Winamp param
+    me = File.expand_path(__FILE__)
+    params = WinampNowPlaying::MusicData::WINAMPDATA_ORDER[0..-2].map{|e| "%#{e}%"}.join('||')
+    param = "#{params}||icon=>:album"
+    warn %Q{"#{me}" "#{param}"}
+    exit(1)
+  end
+end
+
+if $0 == __FILE__ then
+  WinampNowPlaying.new(ENV['SNARL_HOST'], ENV['SNARL_PORT']) do |amp|
+    ## The following applications are registered with Snarl: / nil default
+    amp.app = "Winamp"
+    ## Notification classes: /nil default
+    amp.class = "Now Playing"
+    ## Message "First Line" / nil default
+    amp.title = "Winamp Now Playing:"
+    ## Message Body / Proc is called, String is as-is, default is nil
+    amp.text = lambda{|x| "#{x.data.title}\n#{x.data.artist}\n#{x.data.album}"}
+    ## Message Icon / path is path, :default is Snarl Setting, nil is album
+    ## when nil, if playing dir has "#{@album}.{gif,png,jpg,bmp}", use it as Message icon.
+    # amp.icon = 'C:\icon.jpg'
+
+    ## logger for SNP log output
+    # require 'logger'
+    # output_file = File.join(ENV['HOME'], 'winamp_nowplaying_log_for_rubyw.txt')
+    # amp.logger = Logger.new(output_file)
+
+    amp.show_message
+  end
+end

data/exsample/yahoo_weather.rb

@@ -0,0 +1,35 @@
+#!ruby -Ku
+require 'rubygems'
+require 'open-uri'
+require 'nokogiri'
+$LOAD_PATH.unshift(File.join(File.dirname(File.expand_path(__FILE__)), '/../lib/'))
+require 'snarl/snp'
+
+@uri = 'http://weather.yahoo.co.jp/weather/jp/1b/1400.html'
+@host = ENV['SNARL_HOST'] || ARGV[0] || (if ARGV[0] == '-H' then ARGV[1] else nil end)
+
+def encode_win(s)
+  if s.respond_to?(:encode) then
+    s.dup.encode(::Encoding::SHIFT_JIS)
+  else
+    require 'kconv'
+    s.tosjis
+  end
+end
+
+uri = URI.parse(@uri)
+html = open(uri, 'User-Agent' => 'Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; SV1; .NET CLR 1.0.3705; .NET CLR 2.0.50727; .NET CLR 1.1.4322)').read
+doc = Nokogiri::HTML.parse(html, nil, 'EUC-JP')
+
+place = doc.at('div#cat-pass p').inner_text.split(/>/).last.gsub(/\s+/){''}
+table = doc.at('table.yjw_table tr')
+weather = table.at('img')
+
+title = encode_win("Yahoo! Weather\n#{place}")
+text = encode_win(table.at('table').inner_text.gsub(/\s+/){''})
+icon = weather['src']
+
+Snarl::SNP.open(@host) do |snp|
+  snp.register('Ruby-Snarl')
+  snp.notification(title, text, icon, 20)
+end

data/lib/snarl/autotest.rb

@@ -0,0 +1,112 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'snp'
+
+# Usage:
+# On $HOME/.autotest.
+#     require 'snarl/autotest'
+#     Autotest::Snarl.host = '192.168.0.1'
+module Autotest::Snarl
+
+   @snarl_host = '127.0.0.1'
+   @snarl_port = 9887
+
+   class << self
+     attr_accessor :snarl_host, :snarl_port
+   end
+
+   def self.host
+     ENV['SNARL_HOST'] || Autotest::Snarl.snarl_host
+   end
+   def self.host=(host)
+     Autotest::Snarl.snarl_host = host
+   end
+   def self.port
+     ENV['SNARL_PORT'] || Autotest::Snarl.snarl_port
+   end
+   def self.port=(port)
+     Autotest::Snarl.snarl_port = port.to_i
+   end
+
+  # Windows Snarl shortcut's "working folder" (left click property)
+  # %HOME%\Application Data\full phat\snarl\styles
+  def self.hostdir
+    "./"
+  end
+  def self.icon_ok
+    # %HOME%\Application Data\full phat\snarl\styles\ok.png works fine
+    "ok.png"
+  end
+  def self.icon_fail
+    "fail.png"
+  end
+  def self.icon_pending
+    "pending.png"
+  end
+  def self.app
+    "Autotest::Snarl"
+  end
+
+  def self.iconset
+    {
+      :green    => File.join(hostdir, icon_ok),
+      :red      => File.join(hostdir, icon_fail),
+      :yellow   => File.join(hostdir, icon_pending), # TODO:
+      :info     => nil
+    }
+  end
+
+  def self.classes
+    {
+      'green'   => 'test ok',
+      'red'     => 'test fail',
+      'yellow'  => 'test pending',
+      'info'    => 'system message'
+    }
+  end
+
+  def self.snarl(title, text, status = :info, timeout = nil)
+    Snarl::SNP.open(host, port){|c|
+      c.iconset(iconset)
+      c.register(app)
+      c.add_classes(classes)
+      c.notification(
+                     :title => title,
+                     :text => text,
+                     :class => status.to_s,
+                     :timeout => (timeout||10),
+                     :icon => status)
+    }
+  end
+
+  Autotest.add_hook :run do  |at|
+    snarl("Run", "Run", :info)
+  end
+
+  Autotest.add_hook :red do |at|
+    failed_tests = at.files_to_test.inject(0){ |s,a| k,v = a;  s + v.size}
+    snarl("Tests Failed", "#{failed_tests} tests failed", :red)
+  end
+
+  Autotest.add_hook :green do |at|
+    # TODO: "All tests passed (and pending 3)"
+    snarl("Tests Passed", "All tests passed", :green)
+  end
+
+  Autotest.add_hook :run do |at|
+    snarl("autotest", "autotest was started", :info, 5) if $DEBUG
+  end
+
+  Autotest.add_hook :interrupt do |at|
+    snarl("autotest", "autotest was reset", :info, 5) if $DEBUG
+  end
+
+  Autotest.add_hook :quit do |at|
+    snarl("autotest", "autotest is exiting", :info, 5) if $DEBUG
+  end
+
+  Autotest.add_hook :all do |at|_hook
+    snarl("autotest", "Tests have fully passed", :green)
+  end
+
+end

data/lib/snarl/snp.rb

@@ -0,0 +1,11 @@
+require 'socket'
+
+$LOAD_PATH.unshift(File.dirname(File.expand_path(__FILE__)))
+
+require 'snp/action'
+require 'snp/snp'
+require 'snp/request'
+require 'snp/response'
+require 'snp/error'
+require 'snp/config'
+# require 'snp/addon'