adman 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mark
+
+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

@@ -0,0 +1,7 @@
+Adman allows you to easily share an application with other users on your local network using Bonjour.
+
+FIXME:
+- Add more documentation
+
+TODO:
+- 

data/README.rdoc

@@ -0,0 +1,17 @@
+= adman
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Mark. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "adman"
+    gem.summary = %Q{Easily share apps using Bonjour}
+    gem.description = %Q{Adman makes it easy to publish your application and collaborate with other apps on your local network using Bonjour.}
+    gem.email = "mark@burmis.ca"
+    gem.homepage = "http://github.com/MarkBennett/adman"
+    gem.authors = ["Mark"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.rubyforge_project = "adman"
+    # 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 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "adman #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO

@@ -0,0 +1,2 @@
+- Add code to autoguess the port if we're running in Rails or Sinatra
+- Add code to poll services being broadcast

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/adman.rb

@@ -0,0 +1,21 @@
+require 'dnssd'
+require 'adman/common'
+
+module Adman
+
+  require 'adman/dnssd'
+
+  DEFAULT_PORT = 3000
+
+  TYPE_WEB_SERVER = "_http._tcp"
+  DEFAULT_TYPE = TYPE_WEB_SERVER
+
+  def announce(name, options={})
+    type = options.fetch(:type, DEFAULT_TYPE)
+    domain = nil
+    port = options.fetch(:port, DEFAULT_PORT)
+
+    Adman.broadcaster.register(name, type, nil, port)
+  end
+
+end

data/lib/adman/common.rb

@@ -0,0 +1,11 @@
+module Adman
+  class << self
+
+    # Returns the Broadcaster used by Adman
+    attr_reader :broadcaster
+
+    def broadcaster=(broadcaster)
+      @broadcaster = broadcaster
+    end
+  end
+end

data/lib/adman/dnssd.rb

@@ -0,0 +1,3 @@
+module Adman
+  Adman.broadcaster = DNSSD
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'adman'
+
+class Test::Unit::TestCase
+end

data/test/test_adman.rb

@@ -0,0 +1,82 @@
+require 'helper'
+
+class TestAdman < Test::Unit::TestCase
+
+  include Adman
+
+  context "Announcing a service," do
+    setup do
+      # Replace the standard broadcaster with a mock one
+      @broadcaster = EchoBroadcaster.new
+      Adman.broadcaster = @broadcaster
+
+      # Announce the website
+      @website_name = "My Website"
+      announce @website_name
+
+    end
+
+    should "register it with the broadcaster" do
+      assert @broadcaster.registered?
+    end
+
+    should "broadcast it with the correct name" do
+      assert_equal @broadcaster.registered_name, @website_name
+    end
+
+    should "broadcast it on the default port" do
+      assert_equal @broadcaster.registered_port, Adman::DEFAULT_PORT
+    end
+
+    should "broadcast it as a web server" do
+      assert_equal @broadcaster.registered_type, Adman::DEFAULT_TYPE
+    end
+
+  end
+
+  context "Announcing a service on a port and of a type, " do
+
+    setup do
+      @broadcaster = EchoBroadcaster.new
+      Adman.broadcaster = @broadcaster
+
+      @service_name = "A great service"
+      @port = 80
+      @type = "_git._tcp"
+      announce @service_name, :port => @port, :type => @type
+    end
+
+    should "register it under the correct name" do
+      assert_equal @broadcaster.registered_name, @service_name
+    end
+
+    should "register in on the correct port" do
+      assert_equal @broadcaster.registered_port, @port
+    end
+
+    should "register it as the correct type" do
+      assert_equal @broadcaster.registered_type, @type
+    end
+
+  end
+
+end
+
+class EchoBroadcaster
+  attr_reader :registered_name
+  attr_reader :registered_type
+  attr_reader :registered_domain
+  attr_reader :registered_port
+
+  def registered?
+    @registered ||= false
+  end
+
+  def register(name, type, domain, port)
+    @registered = true
+    @registered_name = name
+    @registered_type = type
+    @registered_domain = domain
+    @registered_port = port
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: adman
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mark
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-06 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Adman makes it easy to publish your application and collaborate with other apps on your local network using Bonjour.
+email: mark@burmis.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+- README.rdoc
+- TODO
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/adman.rb
+- lib/adman/common.rb
+- lib/adman/dnssd.rb
+- test/helper.rb
+- test/test_adman.rb
+- README
+- TODO
+has_rdoc: true
+homepage: http://github.com/MarkBennett/adman
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: adman
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Easily share apps using Bonjour
+test_files: 
+- test/helper.rb
+- test/test_adman.rb