easyjour 0.0.2

data/CHANGELOG

@@ -0,0 +1,3 @@
+v0.0.2. First gem release.
+
+v0.0.1. Initial release.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Elijah Miller
+
+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

@@ -0,0 +1,10 @@
+CHANGELOG
+easyjour.gemspec
+examples/httpjour.rb
+lib/easyjour/version.rb
+lib/easyjour.rb
+LICENSE
+Manifest
+Rakefile
+README
+spec/spec_helper.rb

data/README

@@ -0,0 +1,34 @@
+Easyjour
+========
+
+Super simple access to service announcing and discovery using Bonjour aka DNSSD.
+
+
+Examples
+========
+
+  # garbage_files is an HTTP server available on port 3000
+  Easyjour.serve("garbage_files", 'http', 3000)
+
+
+  # Continously find HTTP servers and print the url
+  search = Easyjour::Search.new('http') do |result|
+    puts "http://#{result.target}:#{result.port}/"
+  end
+
+
+  # Find the Git servers that respond in 5 seconds or less
+  results = Easyjour.synchronous_search(5, 'git')
+  results.each do |result|
+    puts "git://#{result.target}:#{result.port}"
+  end
+  
+
+Install
+=======
+
+gem sources -a http://gems.github.com
+sudo gem install jqr-easyjour
+
+Homepage: http://github.com/jqr/easyjour/tree/master  
+Copyright (c) 2008 Elijah Miller <elijah.miller@gmail.com>, released under the MIT license.

data/Rakefile

@@ -0,0 +1,27 @@
+project_name = 'easyjour'
+website_path = "jqr@rubyforge.org:/var/www/gforge-projects/#{project_name}"
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+require "lib/#{project_name}/version"
+
+require 'echoe'
+Echoe.new project_name, Easyjour::Version do |p|
+  p.description     = "Super simple access to service announcing and discovery using Bonjour aka DNSSD."
+  p.url             = "http://#{project_name}.rubyforge.org"
+  p.author          = "Elijah Miller"
+  p.email           = "elijah.miller@gmail.com"
+  # p.extra_deps      = [['net-mdns', '>= 0.4']]
+  p.need_tar_gz     = false
+  p.docs_host       = website_path
+end
+
+
+Rake::Task[:default].prerequisites.clear
+desc 'Default: run specs'
+task :default => :spec
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+end

data/easyjour.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{easyjour}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Elijah Miller"]
+  s.date = %q{2008-12-06}
+  s.description = %q{Super simple access to service announcing and discovery using Bonjour aka DNSSD.}
+  s.email = %q{elijah.miller@gmail.com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/easyjour/version.rb", "lib/easyjour.rb", "LICENSE", "README"]
+  s.files = ["CHANGELOG", "easyjour.gemspec", "examples/httpjour.rb", "lib/easyjour/version.rb", "lib/easyjour.rb", "LICENSE", "Manifest", "Rakefile", "README", "spec/spec_helper.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://easyjour.rubyforge.org}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Easyjour", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{easyjour}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Super simple access to service announcing and discovery using Bonjour aka DNSSD.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

data/examples/httpjour.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'easyjour')
+
+class HTTPjour
+  def self.serve
+    # This code is webrick example code, slightly modified
+    require 'webrick'
+    include WEBrick
+
+    port = rand(10_000) + 1025
+    s = HTTPServer.new(
+      :Port            => port,
+      :DocumentRoot    => Dir::pwd
+    )
+    Easyjour.serve("webrick-#{port}", 'http', port)
+
+    trap("INT") { s.shutdown }
+    s.start
+  end
+
+
+  def self.search(open = false)
+    puts "Searching for servers... (press control-c to stop)\n\n"
+    search = Easyjour.search('http') do |service|
+      puts " * http://#{service.target}:#{service.port}/"
+      system('open', "http://#{service.target}:#{service.port}/") if open
+    end
+    trap("INT") { exit }
+    loop { sleep 10 }
+  end
+  
+
+  def self.help
+    puts "usage: "
+    puts " serve    # serves the current directory over HTTP"
+    puts " search   # looks for HTTP servers"
+    puts " show     # opens every HTTP server as it finds them"
+    exit
+  end
+end
+
+case ARGV[0]
+when 'serve'
+  HTTPjour.serve
+when 'search'
+  HTTPjour.search
+when 'open'
+  HTTPjour.search(true)
+else
+  HTTPjour.help
+end

data/lib/easyjour/version.rb

@@ -0,0 +1,3 @@
+module Easyjour
+  Version = '0.0.2'
+end

data/lib/easyjour.rb

@@ -0,0 +1,100 @@
+require 'net/dns/mdns-sd'
+
+module Easyjour
+  # Turns a service and protocol into _service._protocol format, automatically
+  # defaults to TCP if no protocol is specified. Also gracefully handles a service
+  # that is already in the _service._protocol format format.
+  def self.type_from_parts(service, protocol = :tcp)
+    if service =~ /^_\w+\._\w+$/
+      service
+    else
+      "_#{service}._#{protocol}"
+    end
+  end
+  
+  # Makes a new service discoverable. Service is discoverable until stop is called.
+  #
+  #  # garbage_files is an HTTP server available on port 3000
+  #  Easyjour.serve("garbage_files", 'http', 3000)
+  def self.serve(name, service, port, text_record = {}, protocol = :tcp)
+    Service.new(name, service, port, text_record, protocol = :tcp)
+  end
+  
+  class Service
+    def initialize(name, service, port, text_record = {}, protocol = :tcp)
+      @service = Net::DNS::MDNSSD.register(name, Easyjour.type_from_parts(service, protocol), 'local', port, text_record)
+    end
+    
+    # Stops a service from being discoverable.
+    def stop
+      @service.stop
+    end
+  end
+  
+  # Initiaites a service search, returns an Easyjour::Search. Search will continue until stop 
+  # is called. Can be given a block for immediate result processing.
+  #
+  #  # Find the HTTP servers that respond in 5 seconds or less
+  #  search = Easyjour.search('http')
+  #  sleep 5
+  #  search.stop
+  #  search.results.each do |result|                      # access the entire result set
+  #    puts "http://#{result.target}:#{result.port}/"
+  #  end  
+  #
+  #  # Continously find HTTP servers
+  #  search = Easyjour.search('http') do |result|
+  #    puts "http://#{result.target}:#{result.port}/"
+  #  end
+  #  search.results                                       # result set is updated as servers respond
+  def self.search(service, protocol = :tcp, &block)
+    Search.new(service, protocol, &block)
+  end
+
+  # Searches for a service for timeout seconds and returns the results after stopping the search.
+  # Can be given a block for immediate result processing.
+  #
+  #  # Find the Git servers that respond in 5 seconds or less
+  #  results = Easyjour.search(5, 'git')
+  #  results.each do |result|
+  #    puts "git://#{result.target}:#{result.port}"
+  #  end
+  def self.synchronous_search(timeout, service, protocol = :tcp, &block)
+    search = Search.new(service, protocol, &block)
+    sleep timeout
+    search.stop
+    search.results
+  end
+  
+  
+  class Search
+    def initialize(service, protocol = :tcp)
+      @results = []
+      @results_mutex = Mutex.new
+      
+      @query = Net::DNS::MDNSSD.browse(Easyjour.type_from_parts(service, protocol), 'local') do |reply|
+        Net::DNS::MDNSSD.resolve(reply.name, reply.type, reply.domain) do |reply|          
+          yield(reply) if block_given?
+
+          @results_mutex.synchronize do
+            @results << reply
+          end
+        end
+      end
+    end
+    
+    # Returns the current the results.
+    def results
+      @results_mutex.synchronize do
+        @results
+      end
+    end
+    
+    # Stop the search.
+    def stop
+      @query.stop
+    end
+    
+  end
+
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: easyjour
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Elijah Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-06 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Super simple access to service announcing and discovery using Bonjour aka DNSSD.
+email: elijah.miller@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/easyjour/version.rb
+- lib/easyjour.rb
+- LICENSE
+- README
+files: 
+- CHANGELOG
+- easyjour.gemspec
+- examples/httpjour.rb
+- lib/easyjour/version.rb
+- lib/easyjour.rb
+- LICENSE
+- Manifest
+- Rakefile
+- README
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://easyjour.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Easyjour
+- --main
+- README
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: easyjour
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Super simple access to service announcing and discovery using Bonjour aka DNSSD.
+test_files: []
+