spidah-ruby_gntp 0.1.2

data/ChangeLog

@@ -0,0 +1,18 @@
+= ruby_gntp change log
+
+== Version 0.0.0
+* Create public Git repository
+
+== Version 0.0.1
+* Initial version
+
+== Version 0.0.2
+* Fixed Japanese translated MIT License page URL.
+
+== Version 0.1.0 - 2009/4/17
+* Add GNTP.notify method for instant notification.
+* Add ruby script examples.
+
+== Version 0.1.1 - 2009/4/17
+* Add NOTE to example directory.
+

data/README

@@ -0,0 +1,33 @@
+Ruby library for GNTP(Growl Notification Transport Protocol)
+
+Sorry, document is not avilable now.
+
+Usage example:
+
+require 'rubygems'
+require 'ruby_gntp'
+
+# -- Standard way
+growl = GNTP.new("Ruby/GNTP self test")
+growl.register({:notifications => [{
+  :name     => "notify",
+  :enabled  => true,
+}]})
+
+growl.notify({
+  :name  => "notify",
+  :title => "Congraturation",
+  :text  => "Congraturation! You are successful install ruby_gntp.",
+  :icon  => "http://www.hatena.ne.jp/users/sn/snaka72/profile.gif",
+  :sticky=> true,
+})
+
+# -- Instant notification
+GNTP.notify({
+  :app_name => "Instant notify",
+  :title    => "Instant notification", 
+  :text     => "Instant notification available now.",
+  :icon     => "http://www.hatena.ne.jp/users/sn/snaka72/profile.gif",
+})
+
+

data/TODO

@@ -0,0 +1,4 @@
+= TODO
+* Include test code into gem
+* Write RDoc comment
+

data/example/gntp-notify

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby
+# Growl notifier command
+# Usage:
+#  gntp-notify [message]
+# License:
+#  public domain
+
+require "rubygems"
+require "ruby_gntp" # >= ver.0.1.0 
+
+msg = ARGV[0] || "Alert!!"
+
+GNTP.notify({
+  :app_name  => "gntp-notify",
+  :title => "from commandline",
+  :text  => msg,
+  :sticky=> true,
+})
+

data/example/twitter_notifier.rb

@@ -0,0 +1,107 @@
+#!/usr/bin/ruby
+#
+# Ruby/GNTP example : twitter notifier
+#
+# Usage: {{{
+#     Please type the following command from command line, 
+#     and then, this script gets your time-line every 30 seconds.
+#
+#     > ruby twitter_notifyer.rb
+#
+#     If you want *STOP* this script, so press Ctrl + 'C'.
+#
+# Require environment variables:
+#   - EDITOR     : For Pit uses this variable to edit account information.
+#                   ex) set EDITOR = c:\Progra~1\vim71\vim.exe
+#
+#   - HTTP_PROXY : If you access the Internet via proxy server, you need
+#                  this variable setting.
+#                  If variable's value icludes protcol scheme('http://' etc.)
+#                  would ignore that.
+#                   ex) set HTTP_PROXY = http://proxy.host.name:8080
+#                         or
+#                       set HTTP_PROXY = proxy.host.name:8080
+#
+# Web page:
+#   http://d.hatena.ne.jp/snaka72/
+#   http://sumimasen2.blogspot.com/
+#
+# License: public domain
+# }}}
+
+require 'net/http'
+
+require 'rubygems'
+require 'json'
+require 'pit'
+require 'ruby_gntp'
+
+$tweeted = {}
+
+$growl = GNTP.new
+$growl.register({
+  :app_name => "Twitter",
+  :notifications => [{ :name => "Tweet", :enabled => true },
+               	     { :name => "Error", :enabled => true }]
+})
+
+def get_timeline
+
+  max_count = 20
+
+  config = Pit.get("twitter", :require => {
+    "username" => "your twittername",
+    "password" => "your password"
+  })
+
+  Net::HTTP.version_1_2
+  req = Net::HTTP::Get.new('/statuses/friends_timeline.json')
+  req.basic_auth config["username"], config["password"]
+
+  proxy_host, proxy_port = (ENV["HTTP_PROXY"] || '').sub(/http:\/\//, '').split(':')
+
+  Net::HTTP::Proxy(proxy_host, proxy_port).start('twitter.com') {|http|
+    res = http.request(req)
+
+    if res.code != '200'
+      $growl.notify({
+        :name  => "Error",
+        :title => "Error occurd",
+        :test  => "Can not get messages"
+      })
+      puts res if $DEBUG
+      return
+    end
+
+    results = JSON.parser.new(res.body).parse()
+    results.reverse!
+    results.length.times do |i|
+      break if i >= max_count
+
+      id = results[i]["id"]
+      next if $tweeted.include?(id)
+
+      puts screen_name  = results[i]["user"]["screen_name"]
+      puts text         = results[i]["text"]
+      puts icon         = results[i]["user"]["profile_image_url"]
+
+      $growl.notify({
+        :name => "Tweet",
+        :title =>  screen_name,
+        :text => text,
+        :icon => icon
+      })
+      $tweeted[id] = true
+
+      sleep 1
+    end
+  }
+end
+
+# Check timeline evry 30 seconds.
+while true do
+  get_timeline
+  sleep 30
+end
+
+# vim: ts=2 sw=2 et fdm=marker

data/lib/ruby_gntp.rb

@@ -0,0 +1,206 @@
+#!/usr/bin/ruby
+#
+# Ruby library for GNTP/1.0
+#
+# LICENSE:{{{
+#  Copyright (c) 2009 snaka<snaka.gml@gmail.com>
+#
+#   The MIT License
+#   Permission is hereby granted, free of charge, to any person obtaining a copy
+#   of this software and associated documentation files (the "Software"), to deal
+#   in the Software without restriction, including without limitation the rights
+#   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#   copies of the Software, and to permit persons to whom the Software is
+#   furnished to do so, subject to the following conditions:
+#
+#   The above copyright notice and this permission notice shall be included in
+#   all copies or substantial portions of the Software.
+#
+#   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+#   THE SOFTWARE.
+#
+#   Japanese:
+#   http://sourceforge.jp/projects/opensource/wiki/licenses%2FMIT_license
+#
+#}}}
+require 'socket'
+require 'digest/md5'
+
+#$DEBUG = true
+
+class TooFewParametersError < Exception
+end
+
+class GNTP
+  attr_reader :app_name, :target_host, :target_port, :password
+  attr_reader :message if $DEBUG
+
+  def initialize(app_name = 'Ruby/GNTP', host = 'localhost', password = '', port = 23053)
+    @app_name    = app_name
+    @target_host = host
+    @target_port = port
+    @password = password
+  end
+
+  #
+  # register
+  #
+  def register(params)
+    @notifications = params[:notifications]
+    raise TooFewParametersError, "Need least one 'notification' for register" unless @notifications
+
+    @app_icon = params[:app_icon]
+
+    @message = <<EOF
+#{get_gntp_header_start('REGISTER')}
+Application-Name: #{@app_name}
+Notifications-Count: #{@notifications.size}
+EOF
+    @message << "Application-Icon: #{@app_icon}\n" if @app_icon
+    @message << "\n"
+
+    @notifications.each do |notification|
+      name      = notification[:name]
+      disp_name = notification[:disp_name]
+      enabled   = notification[:enabled] || true
+      icon      = notification[:icon]
+
+      @message += <<EOF
+Notification-Name: #{name}
+EOF
+      @message << "Notification-Display-Name: #{disp_name}\n" if disp_name
+      @message << "Notification-Enabled: #{enabled}\n"        if enabled
+      @message << "Notification-Icon: #{icon}\n"              if icon
+      @message << "\n"
+    end
+
+    unless (ret = send_and_recieve(@message))
+      raise "Register failed"
+    end
+  end
+
+
+  #
+  # notify
+  #
+  def notify(params)
+    name   = params[:name]
+    raise TooFewParametersError, "Notification need 'name', 'title' parameters" unless name || title
+
+    title  = params[:title]
+    text   = params[:text]
+    icon   = params[:icon] || get_notification_icon(name)
+    sticky = params[:sticky]
+
+    @message = <<EOF
+#{get_gntp_header_start('NOTIFY')}
+Application-Name: #{@app_name}
+Notification-Name: #{name}
+Notification-Title: #{title}
+EOF
+    @message << "Notification-Text: #{text}\n"     if text
+    @message << "Notification-Sticky: #{sticky}\n" if sticky
+    @message << "Notification-Icon: #{icon}\n"     if icon
+    @message << "\n"
+
+    unless (ret = send_and_recieve(@message))
+      raise "Notify failed"
+    end
+  end
+
+
+  #
+  # instant notification
+  #
+  def self.notify(params)
+    growl = GNTP.new(params[:app_name])
+    notification = params
+    notification[:name] = params[:app_name] || "Ruby/GNTP notification"
+    growl.register(:notifications => [
+      :name => notification[:name]
+    ])
+    growl.notify(notification)
+  end
+
+  private
+
+  #
+  # send and recieve
+  #
+  def send_and_recieve msg
+    msg.gsub!(/\n/, "\r\n")
+    print msg if $DEBUG
+
+    sock = TCPSocket.open(@target_host, @target_port)
+    sock.write msg
+
+    ret = nil
+    while rcv = sock.gets
+      break if rcv == "\r\n"
+      print ">#{rcv}" if $DEBUG
+      ret = $1 if /GNTP\/1.0\s+-(\S+)/ =~ rcv
+    end
+    sock.close
+
+    return 'OK' == ret
+  end
+
+  #
+  # get notification icon
+  #
+  def get_notification_icon(name)
+    notification = @notifications.find {|n| n[:name] == name}
+    return nil unless notification
+    return notification[:icon]
+  end
+
+  #
+  # get start of the GNTP header
+  #
+  def get_gntp_header_start(type)
+    if @password.empty?
+      "GNTP/1.0 #{type} NONE"
+    else
+      saltvar = Time.now.to_s
+      salt = Digest::MD5.digest(saltvar)
+      salthash = Digest::MD5.hexdigest(saltvar)
+      key = Digest::MD5.digest("#{@password}#{salt}")
+      keyhash = Digest::MD5.hexdigest(key)
+      "GNTP/1.0 #{type} NONE MD5:#{keyhash}.#{salthash}"
+    end
+  end
+end
+
+#----------------------------
+# self test code
+if __FILE__ == $0
+  #--- Use standard notification method ('register' first then 'notify')
+  growl = GNTP.new("Ruby/GNTP self test")
+  growl.register({:notifications => [{
+      :name     => "notify",
+      :enabled  => true,
+  }]})
+
+  growl.notify({
+    :name  => "notify",
+    :title => "Congraturation",
+    :text  => "Congraturation! You are successful install ruby_gntp.",
+    :icon  => "http://www.hatena.ne.jp/users/sn/snaka72/profile.gif",
+    :sticky=> true,
+  })
+
+  #--- Use instant notification method (just 'notify')
+  GNTP.notify({
+    :app_name => "Instant notify",
+    :title    => "Instant notification", 
+    :text     => "Instant notification available now.",
+    :icon     => "http://www.hatena.ne.jp/users/sn/snaka72/profile.gif",
+  })
+end
+
+# vim: ts=2 sw=2 expandtab fdm=marker

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: spidah-ruby_gntp
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- snaka
+- David Hayward (spidah)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-16 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: 
+- snaka.gml@gmail.com
+- spidahman@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/ruby_gntp.rb
+- example/twitter_notifier.rb
+- example/gntp-notify
+- README
+- TODO
+- ChangeLog
+has_rdoc: false
+homepage: http://snaka.github.com/ruby_gntp/
+licenses: 
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Ruby library for GNTP(Growl Notification Transport Protocol) client
+test_files: []
+