siuying-cardjour 0.1.0

data/History.txt

@@ -0,0 +1,3 @@
+== 0.1.0 2008-09-07
+
+* First release. Basic listing and publishing feature.

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 FIXME full name
+
+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/Manifest.txt

@@ -0,0 +1,31 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+bin/cardjour
+config/hoe.rb
+config/requirements.rb
+lib/cardjour.rb
+lib/cardjour/application.rb
+lib/cardjour/command/help.rb
+lib/cardjour/command/list.rb
+lib/cardjour/command/publish.rb
+lib/cardjour/service.rb
+lib/cardjour/version.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_cardjour.rb
+test/test_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/PostInstall.txt

@@ -0,0 +1,3 @@
+For more information on cardjour, see http://www.reality.hk/cardjour
+
+

data/README.txt

@@ -0,0 +1,51 @@
+= cardjour
+
+* card.reality.hk
+
+== DESCRIPTION:
+
+Share and discover business card (VCard) with others in a LAN, using 
+Bonjour.
+
+== FEATURES/PROBLEMS:
+
+NONE YET.
+
+== SYNOPSIS:
+
+% cardjour list
+% cardjour publish <vcard-file> [port] [description]"
+
+== REQUIREMENTS:
+
+* dnssd
+* vpim
+
+== INSTALL:
+
+sudo gem install cardjour
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIXME full name
+
+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/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/bin/cardjour

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+#require 'rubygems'
+require 'cardjour'
+
+trap "INT" do
+  exit!
+end
+
+Cardjour::Application.run(*ARGV)

data/config/hoe.rb

@@ -0,0 +1,73 @@
+require 'cardjour/version'
+
+AUTHOR = 'Francis CHONG'  # can also be an array of Authors
+EMAIL = "siu [dot] ying [at] reality [dot] hk"
+DESCRIPTION = "Share business card (VCard) with others in LAN, using Bonjour"
+GEM_NAME = 'cardjour' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'cardjour' # The unix name for your project
+HOMEPATH = "http://cardjour.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+  ['vpim', '>= 0.0.0'],
+  ['net-mdns', '>= 0.0.0']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "siuying"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Cardjour::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'cardjour2 documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/cardjour.rb

@@ -0,0 +1,7 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'cardjour/application'
+
+module Cardjour
+end

data/lib/cardjour/application.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'net/dns/mdns-sd'
+require 'cardjour/service'
+require 'cardjour/command/help'
+require 'cardjour/command/list'
+require 'cardjour/command/publish'
+
+Thread.abort_on_exception = true
+module Cardjour
+  CJ_SERVICE_NAME = "Cardjour"
+  CJ_BONJOUR_NAME = "_cardjour._tcp"
+  VCardService = Struct.new(:name, :host, :port, :description)
+  DNSSD = Net::DNS::MDNSSD
+  
+  class Application
+    class << self
+      include Command::List
+      include Command::Publish
+      include Command::Help
+      
+      # Entry point
+      def run(*args)
+        case args.shift
+          when "publish"
+            publish(*args)
+          when "list"
+            list
+          else
+            help
+        end
+      end
+    end
+  end
+end

data/lib/cardjour/command/help.rb

@@ -0,0 +1,11 @@
+module Cardjour
+  module Command
+    module Help
+      def help
+        puts "usage: cardjour publish <vcard-file> [port] [description]"
+        puts "usage: cardjour list"
+      end
+      module_function :help      
+    end
+  end
+end

data/lib/cardjour/command/list.rb

@@ -0,0 +1,52 @@
+require 'set'
+
+module Cardjour
+  module Command
+    module List
+      VCardService = Struct.new(:name, :host, :port, :description)
+
+      # List services to console
+      def list
+      	service_list.each do |service|
+          puts "=== #{service.name} on #{service.host}:#{service.port} ==="
+          puts "  #{service.description}"
+          puts "    http://#{service.host}:#{service.port}/"
+          puts
+        end
+      end
+      module_function :list
+      
+      private
+      # Discover and Retrieve list of services
+      def service_list
+        list = Set.new
+        discover { |obj| list << obj }
+        return list
+      end
+      module_function :service_list
+      
+      # Discover list of services
+      def discover(timeout=5)
+        waiting_thread = Thread.current
+        dns = DNSSD.browse CJ_BONJOUR_NAME do |reply|
+          DNSSD.resolve reply.name, reply.type, reply.domain do |resolve_reply|
+            service = VCardService.new(reply.name,
+                                     resolve_reply.target,
+                                     resolve_reply.port,
+                                     resolve_reply.text_record['description'].to_s)
+            begin
+              yield service
+            rescue Done
+              waiting_thread.run
+            end
+          end
+        end
+        puts "Gathering for up to #{timeout} seconds..."
+        sleep timeout
+        dns.stop
+      end
+      module_function :discover
+      
+    end
+  end
+end

data/lib/cardjour/command/publish.rb

@@ -0,0 +1,23 @@
+require 'vpim/vcard'
+require 'net/dns/mdns-sd'
+
+module Cardjour
+  module Command
+    module Publish
+      # Publish the card service
+      def publish(card, *rest)
+        vcard = Vpim::Vcard.decode(open(card)).first
+        username = vcard.name.fullname rescue "Unknown"
+        port = rest.shift || 3300
+        description = rest.shift || "#{username}'s Cardjour"
+
+        DNSSD.register(username, CJ_BONJOUR_NAME, 'local', port.to_i, { "description" => description }) do |rr|
+          puts "Registered #{username} on port #{port}. Starting service."
+        end
+        
+        Service.new(port.to_i, card).start
+      end
+      module_function :publish      
+    end
+  end
+end

data/lib/cardjour/service.rb

@@ -0,0 +1,26 @@
+require 'webrick'
+module Cardjour
+  class Service    
+    def initialize(port, file)
+      @port = port
+      @file = file
+      @card = nil
+    end
+
+    def start
+      puts "serving at #{@port} with #{@file}"
+      http = WEBrick::HTTPServer.new(:Port => @port.to_i)
+      http.mount_proc("/") { |req, res| index(req, res) }
+      trap("INT") { http.shutdown }
+      t = Thread.new { http.start }
+      t.join
+    end
+
+    private
+    def index(req, res)
+      res['Content-Type'] = 'text/x-vCard'
+      res["Content-Disposition"] = "attachment; filename=#{File.basename(@file)}"
+      res.body = open(@file).read
+    end
+  end
+end

data/lib/cardjour/version.rb

@@ -0,0 +1,9 @@
+module Cardjour
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/cardjour.rb'}"
+puts "Loading cardjour gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)