shuttlecraft 0.0.1

data/.autotest

@@ -0,0 +1,25 @@
+# -*- ruby -*-
+
+require "autotest/restart"
+
+# Autotest.add_hook :initialize do |at|
+#   at.testlib = "minitest/unit"
+#
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception "vendor"
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,6 @@
+=== 0.0.1 / 2013-10-07
+
+* 1 major enhancement
+
+  * Birthday!
+

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Davy Stevenson
+
+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,20 @@
+.autotest
+History.txt
+LICENSE
+Manifest.txt
+README.md
+Rakefile
+bin/mothership_app
+bin/shuttlecraft_app
+lib/shuttlecraft.rb
+lib/shuttlecraft/mothership.rb
+lib/shuttlecraft/mothership_app.rb
+lib/shuttlecraft/protocol.rb
+lib/shuttlecraft/comms.rb
+lib/shuttlecraft/resolv.rb
+lib/shuttlecraft/shuttlecraft_app.rb
+lib/shuttlecraft/test.rb
+ringserver.rb
+test/test_shuttlecraft.rb
+test/test_shuttlecraft_mothership.rb
+test/test_shuttlecraft_protocol.rb

data/README.md

@@ -0,0 +1,76 @@
+# shuttlecraft
+
+* http://github.com/davy/shuttlecraft
+
+## DESCRIPTION:
+
+Shuttlecraft is an easy-to-use wrapper for much of the functionality in Rinda. 
+
+Create a Shuttlecraft::Mothership to manage the RingServer and RingProvider, and then many Shuttlecrafts can easily connect to the Mothership. Registration management is easy and automatic.
+
+Easily broadcast messages to all registered services (ie. Shuttlecrafts) from either the Mothership or a particular Shuttlecraft.
+
+
+## SYNOPSIS:
+
+Running the apps
+----------------
+
+Requires [shoes4](https://github.com/shoes/shoes4). Shoes4 is under active development! Apps tested against commit [7d0a1ee](https://github.com/shoes/shoes4/commit/7d0a1eefea601917dd01419b14ded2812d0acb9f).
+
+Make sure you are running a ring server (via [RingyDingy](https://github.com/drbrain/RingyDingy))
+
+        $ ring_server
+        
+Run Mothership
+
+        $ path/to/shoes bin/mothership_app
+        
+Run Shuttlecraft
+
+        $ path/to/shoes bin/shuttlecraft_app
+        
+Play!
+
+* Run multiple Motherships or Shuttlecrafts
+* Shuttlecraft will ask which Mothership to connect to
+* Can rescan for Motherships if none are available initially
+* Broadcast a message to all running Shuttlecrafts registered with a Mothership
+
+## INSTALL:
+
+        $ gem install shuttlecraft 
+
+## DEVELOPERS:
+
+After checking out the source, run:
+
+        $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+## LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2013 Davy Stevenson, Eric Hodel
+
+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,20 @@
+# -*- ruby -*-
+
+require "rubygems"
+require "hoe"
+
+Hoe.plugin :minitest
+Hoe.plugin :git
+
+Hoe.spec 'shuttlecraft' do
+  developer 'Davy Stevenson', 'davy.stevenson@gmail.com'
+  developer 'Eric Hodel', 'drbrain@segment7.net'
+
+  extra_deps << ['RingyDingy', '~> 1.6']
+
+  self.readme_file = 'README.md'
+
+  license 'MIT' # this should match the license in the README
+end
+
+# vim: syntax=ruby

data/bin/mothership_app

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'shuttlecraft'
+
+Shuttlecraft::MothershipApp.run

data/bin/shuttlecraft_app

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'shuttlecraft'
+
+Shuttlecraft::ShuttlecraftApp.run

data/lib/shuttlecraft.rb

@@ -0,0 +1,111 @@
+require 'rinda/ring'
+
+require 'shuttlecraft/comms'
+
+class Shuttlecraft
+
+  include Shuttlecraft::Comms
+
+  VERSION = '0.0.1'
+
+  # [:name, :Mothership, name, Rinda::TupleSpace:tuplespace]
+  PROVIDER_TEMPLATE = [:name, :Mothership, String, nil]
+
+  # [:name, name, drb_uri]
+  REGISTRATION_TEMPLATE = [:name, String, String]
+
+  attr_accessor :ring_server, :mothership, :name, :protocol
+
+  def initialize(opts={})
+    initialize_comms(opts)
+
+    @drb = DRb.start_service(nil, self)
+
+    @name = opts[:name] || self.class.default_name
+    @protocol = opts[:protocol] || Shuttlecraft::Protocol.default
+    @verbose = opts[:verbose] || false
+
+    @ring_server = Rinda::RingFinger.primary
+    @receive_loop = nil
+  end
+
+  def self.default_name
+    'Shuttlecraft'
+  end
+
+  def provider_template
+    temp = PROVIDER_TEMPLATE.dup
+    temp[1] = @protocol.service_name
+    temp
+  end
+
+  def find_all_motherships
+    ring_server.read_all(provider_template).collect{|_,_,name,ts| {name: name, ts: ts}}
+  end
+
+  def initiate_communication_with_mothership(name=nil)
+    motherships = find_all_motherships
+
+    if name
+      provider = motherships.detect{|m| m[:name] == name}
+    else
+      provider = motherships.first
+    end
+
+    if provider
+      @mothership = Rinda::TupleSpaceProxy.new provider[:ts]
+    end
+  end
+
+  def register
+    update!
+    unless @mothership.nil? || registered?
+      begin
+        @mothership.write([:name, @name, DRb.uri])
+      rescue DRb::DRbConnError
+        # mothership went away =(
+      end
+    end
+  end
+
+  def registered?
+    update!
+    return false unless @mothership
+
+    !registered_services.detect{|t| !t.nil? && t[0] == @name && t[1] == DRb.uri}.nil?
+  end
+
+  def unregister
+    update!
+    if registered?
+      begin
+        @mothership.take([:name, @name, DRb.uri])
+      rescue DRb::DRbConnError
+        # mothership went away =(
+      end
+    end
+  end
+
+  private
+
+  ##
+  # For Shuttlecraft::Comms
+  def tuplespace
+    @mothership
+  end
+end
+
+require 'shuttlecraft/mothership'
+require 'shuttlecraft/protocol'
+require 'shuttlecraft/mothership_app'
+require 'shuttlecraft/shuttlecraft_app'
+
+if __FILE__ == $0
+  s = Shuttlecraft.new
+  s.initate_communication_with_mothership
+  s.register
+
+  sleep(5)
+
+  s.unregister
+end

data/lib/shuttlecraft/comms.rb

@@ -0,0 +1,79 @@
+##
+# Must define tuplespace to read from
+#    def tuplespace
+#
+# Must call initialize_comms inside initialize
+#
+class Shuttlecraft
+  module Comms
+
+    def initialize_comms(opts={})
+      @registered_services_ary = []
+      @update_every = opts[:update_every] || 2
+      @last_update = Time.at 0
+    end
+
+    def registered_services
+      update
+      @registered_services_ary
+    end
+
+    ##
+    # Registered services are only updatable if they haven't been updated in the
+    # last @update_every seconds. This prevents DRb message spam.
+    def update?
+      (@last_update + @update_every) < Time.now
+    end
+
+    ##
+    # Retrieve the last registration data from the TupleSpace.
+    def update
+      return unless update?
+      @last_update = Time.now
+      @registered_services_ary = read_registered_services
+    end
+
+    ##
+    # Forces retrieval of registrations from the TupleSpace.
+    def update!
+      @last_update = Time.at 0
+      update
+    end
+
+    ##
+    # Enumerates through each registered service's uri
+    def each_service_uri
+      return enum_for __method__ unless block_given?
+
+      registered_services.each do |_, uri|
+        yield uri
+      end
+    end
+
+    ##
+    # Loops through each client and yields
+    # DRb object for that client
+    def each_client
+      each_service_uri do |uri|
+        begin
+          remote = DRbObject.new_with_uri(uri)
+          yield remote
+        rescue DRb::DRbConnError
+        rescue => e
+          puts "Error sending message to client: #{e.message}" if @verbose
+        end
+      end
+    end
+
+    private
+
+    def read_registered_services
+      begin
+        tuplespace.read_all(Shuttlecraft::REGISTRATION_TEMPLATE).collect{|_,name,uri| [name,uri]}
+      rescue DRb::DRbConnError
+        []
+      end
+    end
+
+  end
+end

data/lib/shuttlecraft/mothership.rb

@@ -0,0 +1,94 @@
+require 'rinda/ring'
+require 'rinda/tuplespace'
+
+class Shuttlecraft::Mothership
+
+  include Shuttlecraft::Comms
+
+  attr_reader :ts, :provider, :name, :protocol
+
+  def initialize(opts={})
+    initialize_comms(opts)
+
+    @drb = DRb.start_service
+
+    @protocol = opts[:protocol] || Shuttlecraft::Protocol.default
+    @name = opts[:name] || @protocol.name
+    @verbose = opts[:verbose] || false
+
+    @ts = Rinda::TupleSpace.new
+
+    renewer = Rinda::SimpleRenewer.new 10
+
+    @provider =
+      Rinda::RingProvider.new(@protocol.service_name, @name, @ts, renewer)
+    @provider.provide
+
+    notify_on_registration
+    notify_on_unregistration
+    notify_on_write
+  end
+
+
+  ##
+  # Override this method to add custom registration restrictions
+  def allow_registration?
+    true
+  end
+
+  def notify_on_registration
+    @registration_observer = @ts.notify('write', Shuttlecraft::REGISTRATION_TEMPLATE)
+    Thread.new do
+      @registration_observer.each do |reg|
+        puts "Recieved registration from #{reg[1][1]}" if @verbose
+        if allow_registration?
+          update!
+          send(:on_registration) if respond_to? :on_registration
+        else
+          puts "Registration not allowed" if @verbose
+          @ts.take(reg[1])
+        end
+      end
+    end
+  end
+
+  def notify_on_unregistration
+    @unregistration_observer = @ts.notify('take', Shuttlecraft::REGISTRATION_TEMPLATE)
+    Thread.new do
+      @unregistration_observer.each do |reg|
+        puts "Recieved unregistration from #{reg[1][1]}" if @verbose
+        update!
+        send(:on_unregistration) if respond_to? :on_unregistration
+      end
+    end
+  end
+
+  def notify_on_write
+    @write_observer = @ts.notify 'write', [nil]
+    Thread.new do
+      @write_observer.each {|n| p n}
+    end
+  end
+
+  private
+
+  ##
+  # For Shuttlecraft::Comms
+  def tuplespace
+    @ts
+  end
+
+end
+
+if __FILE__ == $0
+  m = Shuttlecraft::Mothership.new
+
+  while(true)
+
+    puts "Registered services: #{m.registered_services.join(', ')}"
+
+    sleep(5)
+  end
+
+  DRb.thread.join
+end

data/lib/shuttlecraft/mothership_app.rb

@@ -0,0 +1,46 @@
+class Shuttlecraft::MothershipApp
+
+  def self.run
+    Shoes.app width: 360, height: 360, resizeable: false, title: 'Mothership' do
+      @mothership = nil
+
+      def launch_screen
+        clear do
+          background black
+          title "Build Mothership", stroke: white
+          edit_line text: 'Name' do |s|
+            @name = s.text
+          end
+          button('launch') {
+            @mothership = Shuttlecraft::Mothership.new(name: @name)
+            display_screen
+          }
+        end
+      end
+
+      def display_screen
+        clear do
+          background "#ffffff"
+
+          stack :margin => 20 do
+            title "Mothership #{@mothership.name}"
+
+            stack do
+              para 'Registered Services:'
+              @registrations = para
+            end
+          end
+          animate(5) { @registrations.replace registrations_text }
+        end
+      end
+
+      def registrations_text
+        if @mothership
+          @mothership.registered_services.join(', ')
+        end
+      end
+
+      launch_screen
+    end
+  end
+end

data/lib/shuttlecraft/protocol.rb

@@ -0,0 +1,14 @@
+class Shuttlecraft::Protocol
+
+  attr_reader :service_name, :name
+
+  def initialize(service_name=:Mothership, name='Mothership')
+    @service_name = service_name
+    @name = name
+  end
+
+  def self.default
+    @@default ||= Shuttlecraft::Protocol.new
+    @@default
+  end
+end

data/lib/shuttlecraft/resolv.rb

@@ -0,0 +1,178 @@
+require 'resolv'
+
+class Resolv
+
+  class DNS
+    class Requester
+
+      remove_method :request
+
+      def request(sender, tout)
+        start = Time.now
+        timelimit = start + tout
+        begin
+          sender.send
+        rescue Errno::EHOSTUNREACH
+          # multi-homed IPv6 may generate this
+          raise ResolvTimeout
+        end
+        while true
+          before_select = Time.now
+          timeout = timelimit - before_select
+          if timeout <= 0
+            raise ResolvTimeout
+          end
+          select_result = IO.select(@socks, nil, nil, timeout)
+          if !select_result
+            after_select = Time.now
+            next if after_select < timelimit
+            raise ResolvTimeout
+          end
+          begin
+            reply, from = recv_reply(select_result[0])
+          rescue Errno::ECONNREFUSED, # GNU/Linux, FreeBSD
+                 Errno::ECONNRESET # Windows
+            # No name server running on the server?
+            # Don't wait anymore.
+            raise ResolvTimeout
+          end
+          begin
+            msg = Message.decode(reply)
+          rescue DecodeError
+            next # broken DNS message ignored
+          end
+          if s = sender_for(from, msg)
+            break
+          else
+            # unexpected DNS message ignored
+          end
+        end
+        return msg, s.data
+      end
+
+      def sender_for(addr, msg)
+        @senders[[addr,msg.id]]
+      end
+
+      class MDNSOneShot < UnconnectedUDP # :nodoc:
+        def sender(msg, data, host, port=Port)
+          id = DNS.allocate_request_id(host, port)
+          request = msg.encode
+          request[0,2] = [id].pack('n')
+          sock = @socks_hash[host.index(':') ? "::" : "0.0.0.0"]
+          return @senders[id] =
+            UnconnectedUDP::Sender.new(request, data, sock, host, port)
+        end
+
+        def sender_for(addr, msg)
+          @senders[msg.id]
+        end
+      end
+    end
+  end
+
+  ##
+  # Resolv::MDNS is a one-shot Multicast DNS (mDNS) resolver.  It blindly
+  # makes queries to the mDNS addresses without understanding anything about
+  # multicast ports.
+  #
+  # Information taken form the following places:
+  #
+  # * RFC 6762
+
+  class MDNS < DNS
+
+    ##
+    # Default mDNS Port
+
+    Port = 5353
+
+    ##
+    # Default IPv4 mDNS address
+
+    AddressV4 = '224.0.0.251'
+
+    ##
+    # Default IPv6 mDNS address
+
+    AddressV6 = 'ff02::fb'
+
+    ##
+    # Default mDNS addresses
+
+    Addresses = [
+      [AddressV4, Port],
+      [AddressV6, Port],
+    ]
+
+    ##
+    # Creates a new one-shot Multicast DNS (mDNS) resolver.
+    #
+    # +config_info+ can be:
+    #
+    # nil::
+    #   Uses the default mDNS addresses
+    #
+    # Hash::
+    #   Must contain :nameserver or :nameserver_port like
+    #   Resolv::DNS#initialize.
+
+    def initialize(config_info=nil)
+      if config_info then
+        super({ nameserver_port: Addresses }.merge(config_info))
+      else
+        super(nameserver_port: Addresses)
+      end
+    end
+
+    ##
+    # Iterates over all IP addresses for +name+ retrieved from the mDNS
+    # resolver, provided name ends with "local".  If the name does not end in
+    # "local" no records will be returned.
+    #
+    # +name+ can be a Resolv::DNS::Name or a String.  Retrieved addresses will
+    # be a Resolv::IPv4 or Resolv::IPv6
+
+    def each_address(name)
+      name = Resolv::DNS::Name.create(name)
+
+      return unless name.to_a.last == 'local'
+
+      super(name)
+    end
+
+    def make_udp_requester # :nodoc:
+      nameserver_port = @config.nameserver_port
+      Requester::MDNSOneShot.new(*nameserver_port)
+    end
+
+  end
+
+  def DefaultResolver.replace_resolvers new_resolvers
+    @resolvers = new_resolvers
+  end
+
+end unless Resolv.const_defined? :MDNS
+
+require 'resolv-replace'
+require 'tempfile'
+
+broadcast_hosts = nil
+
+Tempfile.open 'hosts' do |io|
+  io.puts '255.255.255.255 <broadcast>'
+
+  io.flush
+
+  broadcast_hosts = Resolv::Hosts.new io.path
+end
+
+resolvers = [
+  Resolv::MDNS.new,
+  Resolv::Hosts.new,
+  broadcast_hosts,
+  Resolv::DNS.new,
+]
+
+Resolv::DefaultResolver.replace_resolvers resolvers
+

data/lib/shuttlecraft/shuttlecraft_app.rb

@@ -0,0 +1,164 @@
+class MyShuttlecraft < Shuttlecraft
+
+  attr_reader :msg_log
+
+  def initialize(opts={})
+    super(opts)
+    @msg_log = []
+  end
+
+  def broadcast(msg)
+    for _, uri in registered_services
+      begin
+        remote = DRbObject.new_with_uri(uri)
+        remote.say(msg, DRb.uri)
+      rescue DRb::DRbConnError
+      end
+    end
+  end
+
+  def say(msg, from)
+    @msg_log << msg
+    begin
+      remote = DRbObject.new_with_uri(from)
+      remote.message_reciept(@name)
+    rescue DRb::DRbConnError
+    end
+  end
+
+  def message_reciept(from)
+    puts "reciept from #{from}"
+  end
+end
+
+class Shuttlecraft::ShuttlecraftApp
+
+  def self.run
+    @my_app = Shoes.app width: 360, height: 360, resizeable: false, title: 'Shuttlecraft' do
+
+      @shuttlecraft = nil
+
+      def display_screen
+        clear do
+          stack :margin => 20 do
+            title "Shuttlecraft #{@shuttlecraft.name}"
+
+            stack do @status = para end
+
+            @registered = nil
+            @updating_area = stack
+            @msg_stack = stack
+          end
+
+          animate(5) {
+            if @shuttlecraft
+
+              detect_registration_change
+
+              if @registered
+                @registrations.replace registrations_text
+
+                @msg_stack.clear do
+                  for msg in @shuttlecraft.msg_log
+                    para msg
+                  end
+                end
+              end
+            end
+          }
+        end
+      end
+
+      def detect_registration_change
+        if @registered != @shuttlecraft.registered?
+          @registered = @shuttlecraft.registered?
+          @status.replace "#{"Not " unless @registered}Registered"
+          @updating_area.clear do
+            if @registered
+              button("Unregister") { unregister }
+
+              el = edit_line
+
+              button("Send") {
+                @shuttlecraft.broadcast(el.text)
+                el.text = ''
+              }
+              stack do
+                para 'Registered Services:'
+                @registrations = para
+              end
+            else
+              button("Register")    { register }
+            end
+          end
+        end
+      end
+
+      def launch_screen
+        clear do
+          background black
+          title "Build Shuttlecraft", stroke: white
+          edit_line text: 'Name' do |s|
+            @name = s.text
+          end
+          button('launch') {
+            @shuttlecraft = MyShuttlecraft.new(name: @name)
+            initiate_comms_screen
+          }
+        end
+      end
+
+      def initiate_comms_screen
+        clear do
+          background black
+          title "Initiate Comms", stroke: white
+
+          stack do
+            motherships = @shuttlecraft.find_all_motherships
+
+            if motherships.empty?
+              subtitle "No Motherships within range", stroke: white
+            else
+              subtitle "Select Mothership", stroke: white
+            end
+            for mothership in motherships
+              button(mothership[:name]) {|b|
+                begin
+                  @shuttlecraft.initiate_communication_with_mothership(b.text)
+                rescue
+                  initiate_comms_screen
+                end
+                display_screen
+              }
+            end
+
+            button('launch mothership') {
+              load File.dirname(__FILE__) + '/mothership_app.rb'
+            }
+            button('rescan') {
+              initiate_comms_screen
+            }
+          end
+        end
+      end
+
+      def register
+        @shuttlecraft.register if @shuttlecraft
+      end
+
+      def unregister
+        @shuttlecraft.unregister if @shuttlecraft
+      end
+
+      def registrations_text
+        if @shuttlecraft
+          @shuttlecraft.registered_services.join(', ')
+        end
+      end
+
+      launch_screen
+    end
+  ensure
+    @my_app.unregister if @my_app
+  end
+end

data/lib/shuttlecraft/test.rb

@@ -0,0 +1,43 @@
+require 'minitest/autorun'
+require 'shuttlecraft'
+
+class Shuttlecraft::Test < MiniTest::Unit::TestCase
+
+  class StubRingServer
+    def initialize; end
+    def read(*args); return 'foo'; end
+    def write(*args); return 'foo'; end
+  end
+
+  class StubMothership
+
+    def initialize
+      @tuples = []
+    end
+
+    def write(*args)
+      @tuples << args
+    end
+
+    def take(*args)
+      @tuples.delete(args)
+    end
+
+    def read_all(template)
+      @tuples.map{|t,r| t}.select do |t|
+        template[1].nil? or template[1] === t[1]
+      end
+    end
+  end
+end
+
+class Rinda::RingFinger
+  class << self
+    remove_method :primary
+  end
+
+  def self.primary
+    Shuttlecraft::Test::StubRingServer.new
+  end
+end
+

data/ringserver.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby -w
+
+require 'ringy_dingy/ring_server'
+
+puts "You should really use ringy_dingy's ring_server"
+puts "Starting RingServer for you anyway!"
+RingyDingy::RingServer.run
+

data/test/test_shuttlecraft.rb

@@ -0,0 +1,124 @@
+require 'shuttlecraft/test'
+
+class Shuttlecraft::Override < Shuttlecraft
+  def self.default_name
+    'Override'
+  end
+end
+
+class TestShuttlecraft < Shuttlecraft::Test
+
+  def setup
+    @shuttlecraft = Shuttlecraft.new(name: 'Galileo')
+    @shuttlecraft.mothership = Shuttlecraft::Test::StubMothership.new
+    @stub_mothership = @shuttlecraft.mothership
+  end
+
+  def test_initialization
+    assert_equal false, @shuttlecraft.registered?
+    assert_equal 'Galileo', @shuttlecraft.name
+    assert_equal :Mothership, @shuttlecraft.protocol.service_name
+    assert_equal [], @shuttlecraft.registered_services
+  end
+
+  def test_empty_initialization
+    @shuttlecraft = Shuttlecraft.new
+    assert_equal 'Shuttlecraft', @shuttlecraft.name
+  end
+
+  def test_default_name_override
+    @shuttlecraft = Shuttlecraft::Override.new
+    assert_equal 'Override', @shuttlecraft.name
+  end
+
+  def test_each_service_uri
+    @shuttlecraft.registered_services << ['name', DRb.uri]
+
+    e = @shuttlecraft.each_service_uri
+
+    assert_equal DRb.uri, e.next
+
+    uris = []
+
+    @shuttlecraft.each_service_uri do |uri|
+      uris << uri
+    end
+
+    refute_empty uris
+  end
+
+  def test_each_client
+    @shuttlecraft.registered_services << ['name', 'druby://localhost:1234']
+
+    @shuttlecraft.each_client do |client_obj|
+      assert (DRbObject === client_obj)
+      assert_equal 'druby://localhost:1234', client_obj.__drburi
+    end
+  end
+
+  def test_uses_default_protocol
+    assert_equal Shuttlecraft::Protocol.default, @shuttlecraft.protocol
+  end
+
+  def test_update_eh
+    assert @shuttlecraft.update?
+
+    @shuttlecraft.update
+
+    refute @shuttlecraft.update?
+  end
+
+  def test_update
+    make_registrations(%w[Davy Eric])
+
+    assert @shuttlecraft.update
+    refute @shuttlecraft.update
+
+    assert_equal %w[Davy Eric], @shuttlecraft.registered_services_ary.collect{|n,u| n}.sort
+  end
+
+  def test_update_bang
+    make_registrations(%w[Davy Eric])
+    assert @shuttlecraft.update
+
+    assert_equal %w[Davy Eric], @shuttlecraft.registered_services.collect{|n,u| n}.sort
+
+    make_registrations(%w[Davy Eric Rein])
+    assert @shuttlecraft.update!
+
+    assert_equal %w[Davy Eric Rein], @shuttlecraft.registered_services.collect{|n,u| n}.sort
+  end
+
+  def make_registrations regs
+
+    @@regs = regs
+
+    class << @shuttlecraft
+      undef_method :read_registered_services
+    end
+
+    def @shuttlecraft.read_registered_services
+      @@regs.collect{|r| [r, DRb.uri]}
+    end
+
+    def @shuttlecraft.registered_services_ary
+      @registered_services_ary
+    end
+  end
+
+  def test_registration
+    @shuttlecraft.register
+
+    assert_equal true, @shuttlecraft.registered?
+  end
+
+  def test_unregistration
+    @stub_mothership.write([:name, @shuttlecraft.name, DRb.uri])
+
+    assert_equal true, @shuttlecraft.registered?
+
+    @shuttlecraft.unregister
+
+    assert_equal false, @shuttlecraft.registered?
+  end
+end

data/test/test_shuttlecraft_mothership.rb

@@ -0,0 +1,97 @@
+require 'shuttlecraft/test'
+
+class TestShuttlecraftMothership < Shuttlecraft::Test
+
+  def setup
+    @mothership = Shuttlecraft::Mothership.new(name: 'Enterprise')
+  end
+
+  def test_initialization
+    assert_equal 'Enterprise', @mothership.name
+    assert_equal :Mothership, @mothership.protocol.service_name
+    assert_equal [], @mothership.registered_services
+  end
+
+  def test_protocol
+    @mothership = Shuttlecraft::Mothership.new(protocol: Shuttlecraft::Protocol.new(:Foo, "Foobar"))
+
+    assert_equal 'Foobar', @mothership.name
+    assert_equal :Foo, @mothership.protocol.service_name
+  end
+
+  def test_each_service_uri
+    @mothership.registered_services << ['name', DRb.uri]
+
+    e = @mothership.each_service_uri
+
+    assert_equal DRb.uri, e.next
+
+    uris = []
+
+    @mothership.each_service_uri do |uri|
+      uris << uri
+    end
+
+    refute_empty uris
+  end
+
+  def test_each_client
+    @mothership.registered_services << ['name', 'druby://localhost:1234']
+
+    @mothership.each_client do |client_obj|
+      assert (DRbObject === client_obj)
+      assert_equal 'druby://localhost:1234', client_obj.__drburi
+    end
+  end
+
+  def test_uses_default_protocol
+    assert_equal Shuttlecraft::Protocol.default, @mothership.protocol
+  end
+
+  def test_update_eh
+    assert @mothership.update?
+
+    @mothership.update
+
+    refute @mothership.update?
+  end
+
+  def test_update
+    make_registrations(%w[Davy Eric])
+
+    assert @mothership.update
+    refute @mothership.update
+
+    assert_equal %w[Davy Eric], @mothership.registered_services_ary.collect{|n,u| n}.sort
+  end
+
+  def test_update_bang
+    make_registrations(%w[Davy Eric])
+    assert @mothership.update
+
+    assert_equal %w[Davy Eric], @mothership.registered_services.collect{|n,u| n}.sort
+
+    make_registrations(%w[Davy Eric Rein])
+    assert @mothership.update!
+
+    assert_equal %w[Davy Eric Rein], @mothership.registered_services.collect{|n,u| n}.sort
+  end
+
+  def make_registrations regs
+
+    @@regs = regs
+
+    class << @mothership
+      undef_method :read_registered_services
+    end
+
+    def @mothership.read_registered_services
+      @@regs.collect{|r| [r, DRb.uri]}
+    end
+
+    def @mothership.registered_services_ary
+      @registered_services_ary
+    end
+  end
+
+end

data/test/test_shuttlecraft_protocol.rb

@@ -0,0 +1,18 @@
+require 'shuttlecraft/test'
+
+class TestShuttlecraftProtocol < Shuttlecraft::Test
+
+  def setup
+    @protocol = Shuttlecraft::Protocol.new(:MySpecialProtocol, 'Special Snowflake')
+  end
+
+  def test_initialization
+    assert_equal :MySpecialProtocol, @protocol.service_name
+    assert_equal "Special Snowflake", @protocol.name
+  end
+
+  def test_default_protocol
+    assert_equal :Mothership, Shuttlecraft::Protocol.default.service_name
+    assert_equal "Mothership", Shuttlecraft::Protocol.default.name
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: shuttlecraft
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.0.1
+platform: ruby
+authors:
+- Davy Stevenson
+- Eric Hodel
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: RingyDingy
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    none: false
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: minitest
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.7'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.7'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: hoe
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    none: false
+  prerelease: false
+  type: :development
+description: "Shuttlecraft is an easy-to-use wrapper for much of the functionality\
+  \ in Rinda. \n\nCreate a Shuttlecraft::Mothership to manage the RingServer and RingProvider,\
+  \ and then many Shuttlecrafts can easily connect to the Mothership. Registration\
+  \ management is easy and automatic.\n\nEasily broadcast messages to all registered\
+  \ services (ie. Shuttlecrafts) from either the Mothership or a particular Shuttlecraft."
+email:
+- davy.stevenson@gmail.com
+- drbrain@segment7.net
+executables:
+- mothership_app
+- shuttlecraft_app
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- README.md
+files:
+- .autotest
+- History.txt
+- LICENSE
+- Manifest.txt
+- README.md
+- Rakefile
+- bin/mothership_app
+- bin/shuttlecraft_app
+- lib/shuttlecraft.rb
+- lib/shuttlecraft/mothership.rb
+- lib/shuttlecraft/mothership_app.rb
+- lib/shuttlecraft/protocol.rb
+- lib/shuttlecraft/comms.rb
+- lib/shuttlecraft/resolv.rb
+- lib/shuttlecraft/shuttlecraft_app.rb
+- lib/shuttlecraft/test.rb
+- ringserver.rb
+- test/test_shuttlecraft.rb
+- test/test_shuttlecraft_mothership.rb
+- test/test_shuttlecraft_protocol.rb
+- .gemtest
+homepage: http://github.com/davy/shuttlecraft
+licenses:
+- MIT
+post_install_message:
+rdoc_options:
+- --main
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: shuttlecraft
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: Shuttlecraft is an easy-to-use wrapper for much of the functionality in Rinda
+test_files:
+- test/test_shuttlecraft.rb
+- test/test_shuttlecraft_mothership.rb
+- test/test_shuttlecraft_protocol.rb