r_notify 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 571eba555c6f048cff2ad01c0bad0a07ab5e05bd
+  data.tar.gz: 7e9d84eaa80b521117e6233cb3d4900e5be17fb0
+SHA512:
+  metadata.gz: 248a15f3046aeae6a8fa284a7708f236a3a74b984ffee174723d125aec6f894ed697ae0cc23cca9f35b560852dda6cbff95c4bbc8685111641dd5f40968ac58d
+  data.tar.gz: 5ae05c4295d7b29563acab8387b5864df189c5aff5f67451ffc8c22f68d4666e2b872c2c6d6d270f634ae1d0258d933c022f32cf15499ff2faff6e68d1cde805

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubote_notify.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Joakim Reinert
+
+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.

data/README.md

@@ -0,0 +1,75 @@
+# RNotify
+
+RNotify is a notification library written in ruby. It consists of a server and client code which communicate with each other over drb.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rubote_notify'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubote_notify
+
+## Usage
+
+Start a server by running `rnotify-server`. You will be prompted for a password which clients will use to authenticate.
+
+Start a client by running `rnotify-client`. You will again be prompted for a password which will be used to authenticate on the server. Any notifications sent to the server using its push method will be shown on the client.
+
+Example chat program:
+
+1. Start a server
+2. Run following code on clients:
+
+``` ruby
+require 'drb'
+
+class ChatReader
+
+  def initialize(host, port, password)
+    @server = DRbObject.new_with_uri("druby://#{host}:#{port}")
+    @password = password
+  end
+
+  def start
+    loop do
+      message = @server.listen(@password)
+      puts message unless message == :heartbeat
+    end
+  end
+
+end
+
+class ChatWriter
+
+  def initialize(host, port, nick, password)
+    @server = DRbObject.new_with_uri("druby://#{host}:#{port}")
+    @nick = nick
+    @password = password
+  end
+
+  def start
+    loop do
+      print '> '
+      message = "#{@nick}: #{STDIN.gets.chomp}"
+      @server.push(@password, message)
+    end
+  end
+end
+```
+
+You get the picture...
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/rnotify-client

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+
+require 'choice'
+require 'highline/import'
+require 'r_notify/client'
+
+Choice.options do
+
+  header 'Options:'
+
+  option :action do
+    long '--action ACTION'
+    short '-a'
+    valid %w[start stop]
+    cast Symbol
+    default :start
+    desc 'Either start or stop (default: start)'
+  end
+
+  separator ''
+
+  option :host do
+    long '--host HOST'
+    short '-h'
+    desc 'The host of the notification server i.e. example.com. (default: localhost)'
+    default 'localhost'
+  end
+
+  option :port do
+    long '--port PORT'
+    short '-p'
+    cast Integer
+    desc 'The port the server is listening at. (default: 9000)'
+    default 9000
+  end
+
+  option :password do
+    long '--password PASSWORD'
+    short '-P'
+    desc 'The password for the notification server. If omitted it will be prompted for.'
+  end
+
+  option :daemon do
+    long '--daemon'
+    short '-d'
+    desc 'Run daemonized.'
+  end
+
+end
+
+pidfile = nil
+if Choice[:action] == :stop || Choice[:daemon]
+  pidfile = File.join(ENV['HOME'], '.rnotify', 'client.pid')
+  if not Dir.exists?(File.dirname(pidfile))
+    FileUtils.mkdir_p(File.dirname(pidfile))
+  end
+end
+
+if Choice[:action] == :start
+  password = Choice[:password] || ask('Password: ') {|q| q.echo = '*'}
+  if Choice[:daemon]
+    pipe = IO.popen('-')
+    if pipe
+      File.open(pidfile, 'w+') do |file|
+        file.write(pipe.pid)
+      end
+      puts pipe.gets
+      exit
+    end
+    trap('HUP') { File.delete(pidfile) }
+  end
+  client = RNotify::Client.new("druby://#{Choice[:host]}:#{Choice[:port]}", password.to_s)
+  client.start
+else
+  Process.kill('HUP', File.read(pidfile).to_i)
+  puts "Stopped notification client"
+end

data/bin/rnotify-server

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+
+require 'choice'
+require 'highline/import'
+require 'drb'
+require 'r_notify/server'
+
+Choice.options do
+
+  header ''
+
+  option :action do
+    long '--action ACTION'
+    short '-a'
+    valid %w[start stop]
+    cast Symbol
+    default :start
+    desc 'Either start or stop (default: start). Required.'
+  end
+
+  separator ''
+
+  option :port do
+    long '--port PORT'
+    short '-p'
+    cast Integer
+    desc 'The port to listen at. (default: 9000)'
+    default 9000
+  end
+
+  option :password do
+    long '--password PASSWORD'
+    short '-P'
+    desc 'The password which clients will use to authenticate. If omitted it will be prompted for.'
+  end
+
+  option :daemon do
+    long '--daemon'
+    short '-d'
+    desc 'Run daemonized.'
+  end
+
+  option :help do
+    long '--help'
+    desc 'Show this message'
+  end
+
+end
+
+pidfile = nil
+if Choice[:action] == :stop || Choice[:daemon]
+  pidfile = File.join(ENV['HOME'], '.rnotify', 'server.pid')
+  if not Dir.exists?(File.dirname(pidfile))
+    FileUtils.mkdir_p(File.dirname(pidfile))
+  end
+end
+
+if Choice[:action] == :start
+  password = Choice[:password] || ask('Password: ') {|q| q.echo = '*'}
+  if Choice[:daemon]
+    pipe = IO.popen('-')
+    if pipe
+      File.open(pidfile, 'w+') do |file|
+        file.write(pipe.pid)
+      end
+      puts pipe.gets
+      exit
+    end
+    trap('HUP') { File.delete(pidfile) }
+  end
+  DRb.start_service("druby://:#{Choice[:port]}", RNotify::Server.new(password.to_s))
+  puts "Started notification server at #{DRb.uri}"
+  DRb.thread.join
+else
+  Process.kill('HUP', File.read(pidfile).to_i)
+  puts "Stopped notification server"
+end

data/examples/chat_reader.rb

@@ -0,0 +1,46 @@
+require 'drb'
+require 'highline/import'
+require 'choice'
+
+Choice.options do
+
+  option :host do
+    long '--host HOST'
+    short '-h'
+    default 'localhost'
+  end
+
+  option :port do
+    long '--port PORT'
+    short '-p'
+    cast Integer
+    default 9000
+  end
+
+  option :password do
+    long '--passwort PASSWORD'
+    short '-P'
+  end
+
+end
+
+class ChatReader
+
+  def initialize(host, port, password)
+    @server = DRbObject.new_with_uri("druby://#{host}:#{port}")
+    @password = password
+  end
+
+  def start
+    loop do
+      message = @server.listen(@password)
+      puts message unless message == :heartbeat
+    end
+  end
+
+end
+
+password = Choice[:password] || ask('Password: ') {|q| q.echo = '*'}
+reader = ChatReader.new(Choice[:host], Choice[:port], password)
+trap('INT') { exit }
+reader.start

data/examples/chat_writer.rb

@@ -0,0 +1,68 @@
+require 'drb'
+require 'highline/import'
+require 'choice'
+
+Choice.options do
+
+  option :host do
+    long '--host HOST'
+    short '-h'
+    default 'localhost'
+  end
+
+  option :port do
+    long '--port PORT'
+    short '-p'
+    cast Integer
+    default 9000
+  end
+
+  option :nick do
+    long '--nick NICK'
+    short '-n'
+  end
+
+  option :password do
+    long '--password PASSWORD'
+    short '-P'
+  end
+
+end
+
+class ChatWriter
+
+  def initialize(host, port, nick, password)
+    @server = DRbObject.new_with_uri("druby://#{host}:#{port}")
+    @nick = nick
+    @password = password
+  end
+
+  def start
+    @thread = Thread.new do
+      send("#{@nick} joined the room")
+      loop do
+        print '> '
+        message = "#{@nick}: #{STDIN.gets.chomp}"
+        send(message)
+      end
+    end
+  end
+
+  def send(message)
+    @server.push(@password, "#{Time.now.strftime('%H:%M:%S GMT%:::z')} | #{message}")
+  end
+
+  def quit
+    @thread.kill
+    send("#{@nick} left the room")
+  end
+end
+
+nick = Choice[:nick] || ask('Nick: ')
+password = Choice[:password] || ask('Password: ') { |q| q.echo = '*' }
+writer = ChatWriter.new(Choice[:host], Choice[:port], nick, password)
+begin
+  writer.start.join
+rescue Interrupt
+  writer.quit
+end

data/lib/r_notify.rb

@@ -0,0 +1,6 @@
+require "r_notify/version"
+require "r_notify/server"
+require "r_notify/client"
+
+module RNotify
+end

data/lib/r_notify/client.rb

@@ -0,0 +1,37 @@
+module RNotify
+  class Client
+    require 'gir_ffi'
+    require "drb"
+
+    def initialize(server_uri, password)
+      @server_uri = server_uri
+      @server = DRbObject.new_with_uri(@server_uri)
+      @password = password
+      GirFFI.setup :Notify
+      Notify.init("Rubote notify")
+    end
+
+    def start
+      puts "Listening for notifications from #{@server_uri}"
+      loop do
+        message = @server.listen(@password)
+        next if message == :heartbeat
+        notification(message).show
+      end
+    end
+
+    private
+
+    def notification message
+      buffer = message[:buffer]
+      prefix = message[:prefix]
+      message = message[:message]
+      Notify::Notification.new(
+        "<i>#{buffer || "Query"}:</i>",
+        "<b>#{prefix}</b> | #{message}",
+        "dialog-information"
+      )
+    end
+
+  end
+end

data/lib/r_notify/server.rb

@@ -0,0 +1,35 @@
+module RNotify
+  class Server
+
+    def initialize(password)
+      @notification_queue = Queue.new
+      @password = password
+      Thread.new do
+        loop do
+          push(:heartbeat)
+          sleep 30
+        end
+      end
+    end
+
+    def listen(password)
+      authenticate password
+      @notification_queue.pop
+    end
+
+    def push(password, notification)
+      authenticate password
+      @notification_queue.push(notification)
+    end
+
+    class AuthError < SecurityError; end
+
+    private
+
+    def authenticate(password)
+      sleep 1 # slow down brute forcing
+      raise AuthError unless password == @password
+    end
+
+  end
+end

data/lib/r_notify/version.rb

@@ -0,0 +1,3 @@
+module RNotify
+  VERSION = "0.0.1"
+end

data/r_notify.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'r_notify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "r_notify"
+  spec.version       = RNotify::VERSION
+  spec.authors       = ["Joakim Reinert"]
+  spec.email         = ["mail@jreinert.com"]
+  spec.description   = %q{r_notify is a notification library using drb.}
+  spec.summary       = %q{r_notify consists of a server and a client. Multiple clients can connect to a server and exchange notifications.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "highline"
+  spec.add_dependency "choice"
+  spec.add_dependency "gir_ffi"
+
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: r_notify
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joakim Reinert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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: choice
+  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: gir_ffi
+  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: r_notify is a notification library using drb.
+email:
+- mail@jreinert.com
+executables:
+- rnotify-client
+- rnotify-server
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rnotify-client
+- bin/rnotify-server
+- examples/chat_reader.rb
+- examples/chat_writer.rb
+- lib/r_notify.rb
+- lib/r_notify/client.rb
+- lib/r_notify/server.rb
+- lib/r_notify/version.rb
+- r_notify.gemspec
+homepage: ''
+licenses:
+- 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.6
+signing_key: 
+specification_version: 4
+summary: r_notify consists of a server and a client. Multiple clients can connect
+  to a server and exchange notifications.
+test_files: []