journeta 0.1.7 → 0.2.0

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "shoulda", ">= 2.11.3"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0.9.9"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov (>= 0.9.9)
+  shoulda (>= 2.11.3)

data/{History.txt → HISTORY}

@@ -1,4 +1,16 @@
-
+== 0.2.0 2011.03.17
+
+* JRuby 1.6 finally support! And with fully native threads!!!
+* Ruby 1.9 support. (Also with native threads.)
+* Ruby 1.8 no longer active supported. (Never worked well on the old MRI, anyway.)
+* Documentation updates and fixes.
+* Protocol-compatible with 0.1.x series.
+* Moving to "jeweler"-style packaging.
+* Refactoring versioning.
+* Still no great way to write deterministic tests for threaded components. :(  (Help!)
+
+== 0.1.7 2008-10-29
+* Added JournetaEngine#known_peers_in_group(group_name), which returns a hash {uuid => peer} of peers in that group.
 
 == 0.1.6 2008-10-21
 

data/LICENSE

@@ -0,0 +1,51 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of this License; and 
+
+You must cause any modified files to carry prominent notices stating that You changed the files; and 
+
+You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and 
+
+If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

data/License.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2007, OpenRain, LLC. All rights reserved.
+Copyright (c) 2011, Preston Lee Ventures, LLC. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 
@@ -6,6 +6,6 @@ Redistribution and use in source and binary forms, with or without modification,
 
 -Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 
--Neither the name of the OpenRain, LLC nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+-Neither the name of the Preston Lee Ventures, LLC nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/{README.txt → README.rdoc}

@@ -6,14 +6,14 @@
 Journeta is a dirt simple peer discovery and message passing library for processes on the same LAN,
 requiring no advanced networking knowledge to use.
 
-Only core Ruby libraries are required, making the library fairly light. As all data is sent accross
+Only core Ruby libraries are required, making the library fairly light. As all data is sent across
 the wire in YAML form, any arbitrary Ruby object can be sent to peers, provided they..
 
  * Are running a compatible Journeta version.
  * Have access to the same class definitions if you are sending your own custom objects.
  * Do not have a firewall preventing network I/O.
 
-Journeta uses Ruby threading to manage the asynchonous nature of peer-to-peer I/O.
+Journeta uses Ruby threading to manage the asynchronous nature of peer-to-peer I/O.
 Data you send from your application thread will be queued and sent asynrchonously as soon as possible. 
 For insight into events internal to the library, start ruby with the `--debug` options.
 
@@ -21,36 +21,31 @@ For insight into events internal to the library, start ruby with the `--debug` o
 == Use
 
 
- examples/instant_messenger.rb
+ journeta_instant_messenger.rb
  
     A completely distributed, zero-configuration-required chat room script.
     Fire up several instances in separate terminals. Multiple instances on the same machine is ok.
     Everything you type will automatically be sent to all other instances on the LAN!
-    Use `ruby --debug examples/instant_messenger.rb` for detailed internal event details.
+    Use `ruby --debug journeta_instant_messenger.rb` for detailed internal event details.
 
- examples/instant_messenger_gui.rb
+ journeta_network_status.rb
 
-	A GUI version of the above client. Require the wxruby gem. (`sudo gem install wxruby`)
+	Monitors the presence of all peers on the network.
 
- examples/queue_server.rb
- examples/queue_client.rb
+ journeta_queue_server.rb
+ journeta_queue_client.rb
 
 	A simple queue managed by a server. Each client produces jobs to be queued, and processes jobs
 	sent from the server(s). All nodes automatically find eachother. Try running multiples clients,
 	and then multiple servers. Notice that when you have N servers, each job gets run N times,
 	and not necessarilly by the same client!
-
- examples/network_status.rb
-
-	Monitors the presence of all peers on the network.
-
 		
 == Author
 
-Preston Lee <preston.lee at openrain d0t com>
-http://www.prestonlee.com
-http://www.openrain.com
-
+Preston Lee
+* http://www.prestonlee.com
+* https://www.github.com/preston
+* http://twitter.com/prestonism
 
 == Links
 

data/Rakefile

@@ -1,123 +1,57 @@
 require 'rubygems'
-require 'rake'
-require 'rake/clean'
-require 'rake/testtask'
-require 'rake/packagetask'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
-require 'rake/contrib/rubyforgepublisher'
-require 'fileutils'
-require 'hoe'
-
-include FileUtils
-require File.join(File.dirname(__FILE__), 'lib', 'journeta', 'version')
-
-AUTHOR = 'Preston Lee'  # can also be an array of Authors
-EMAIL = "preston.lee@openrain.com"
-DESCRIPTION = "A zero-configuration-required peer-to-peer (P2P) discovery and communications library for closed networks."
-GEM_NAME = 'journeta' # what ppl will type to install your gem
-
-@config_file = "~/.rubyforge/user-config.yml"
-@config = nil
-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 ||= @config["username"]
-end
-
-RUBYFORGE_PROJECT = 'journeta' # The unix name for your project
-HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
-DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
-
-NAME = "journeta"
-REV = nil 
-# UNCOMMENT IF REQUIRED: 
-# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
-VERS = Journeta::VERSION::STRING + (REV ? ".#{REV}" : "")
-CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
-RDOC_OPTS = ['--quiet', '--title', 'journeta documentation',
-    "--opname", "index.html",
-    "--line-numbers", 
-    "--main", "README",
-    "--inline-source"]
-
-class Hoe
-  def extra_deps 
-    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
-  end 
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
 end
+require 'rake'
 
-# 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.author = AUTHOR 
-  p.description = DESCRIPTION
-  p.email = EMAIL
-  p.summary = DESCRIPTION
-  p.url = HOMEPATH
-  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
-  p.test_globs = ["test/**/test_*.rb"]
-  p.clean_globs |= CLEAN  #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 = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
-  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "journeta"
+  gem.homepage = "http://github.com/preston/journeta"
+  gem.license = "Apache 2.0"
+  gem.summary = %Q{A zero-configuration-required peer-to-peer (P2P) discovery and communications library for closed networks.}
+  gem.description = %Q{Journeta is a dirt simple peer discovery and message passing library for processes on the same LAN, requiring no advanced networking knowledge to use. Only core Ruby libraries are required, making the library fairly light. As all data is sent across the wire in YAML form, so any arbitrary Ruby object can be sent to peers, written in any language.}
+  gem.email = "conmotto@gmail.com"
+  gem.authors = ["Preston Lee"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
 end
+Jeweler::RubygemsDotOrgTasks.new
 
-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')
-
-desc 'Generate website files'
-task :website_generate do
-  Dir['website/**/*.txt'].each do |txt|
-    sh %{ ruby scripts/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
-  end
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
 end
 
-desc 'Upload website files to rubyforge'
-task :website_upload do
-  host = "#{rubyforge_username}@rubyforge.org"
-  remote_dir = "/var/www/gforge-projects/#{PATH}/"
-  local_dir = 'website'
-  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
 end
 
-desc 'Generate and upload website files'
-task :website => [:website_generate, :website_upload, :publish_docs]
-
-desc 'Release the website and new gem version'
-task :deploy => [:check_version, :website, :release] do
-  puts "Remember to create SVN tag:"
-  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
-    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
-  puts "Suggested comment:"
-  puts "Tagging release #{CHANGES}"
-end
+task :default => :test
 
-desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
-task :local_deploy => [:website_generate, :install_gem]
-
-task :check_version do
-  unless ENV['VERSION']
-    puts 'Must pass a VERSION=x.y.z release version'
-    exit
-  end
-  unless ENV['VERSION'] == VERS
-    puts "Please update your version.rb to match the release version, currently #{VERS}"
-    exit
-  end
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  # version = File.exist?('VERSION') ? File.read('VERSION') : ""
+	require File.dirname(__FILE__) + '/lib/journeta/version'
+	version = 
+	
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "journeta #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end
-
-

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/{examples/instant_messenger.rb → bin/journeta_instant_messenger.rb}

@@ -1,4 +1,17 @@
 #!/usr/bin/env ruby
+
+banner =<<EOL
+An IRC-like, serverless instant messenger for local area networks.
+Fire up one or more of these on your local network-connected machine.
+Copyright 2011, Preston Lee. http://prestonlee.com
+
+	Usage: #{$0}
+
+EOL
+
+puts banner
+
+
 current_dir = File.dirname(File.expand_path(__FILE__))
 lib_path = File.join(current_dir, '..', 'lib')
 $LOAD_PATH.unshift lib_path

data/bin/journeta_mock_peers.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+#
+# Creates a handful of "mock" peers on the network that are a member of all groups.
+#
+# Author: Preston Lee <conmotto@gmail.com>
+#
+
+current_dir = File.dirname(File.expand_path(__FILE__))
+lib_path = File.join(current_dir, '..', 'lib')
+$LOAD_PATH.unshift lib_path
+
+require 'journeta'
+include Journeta
+
+
+COUNT = 5
+puts "Creating #{COUNT} mock peers."
+instances = []
+for i in 1..COUNT
+  n = Engine.new(:peer_port => (12345 + i))
+  instances.push n
+  n.start
+end
+
+
+puts "Hit <ENTER> to stop all #{COUNT} peer instances exit."
+gets
+instances.each do |i|
+  i.stop
+end
+
+puts "All instances stopped. Exiting..."

data/bin/journeta_peer_fuzzer.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+
+banner =<<EOL
+Sends bogus data to all peer on the network. Test your application
+with this tool to verify it can handle these cases correctly.
+
+current_dir = File.dirname(File.expand_path(__FILE__))
+lib_path = File.join(current_dir, '..', 'lib')
+$LOAD_PATH.unshift lib_path
+
+puts 'Sends a whole bunch of naughty stuff to peers to attempt to induce crashiness.'
+
+# Load up the library!
+require 'journeta'
+include Journeta
+include Journeta::Common
+
+require 'pp'
+
+# We'll join all group to invoke the maximum amount of nastiness.
+# :groups => nil
+@journeta = Engine.new
+
+puts "Starting malicious peer..."
+@journeta.start
+
+puts "Finding peers..."
+sleep Engine::DEFAULT_PRESENCE_PERIOD + 2
+
+puts "Known groups.."
+@journeta.known_groups.each do |g|
+  p g
+end
+
+def fuzz(data)
+  @journeta.send_to_known_peers(data)
+end
+
+class Journeta::Crap
+  attr_accessor :wtf
+end
+
+puts "Sending a whole bunch of bogus crap to all peers. MuahahahahHAHAHA!!!"
+# fuzz(nil) # Client won't allow this :)
+fuzz('wierd string!')
+fuzz(Journeta::Crap.new)
+#fuzz(Journeta::Crap)
+fuzz(42)
+fuzz(42.42)
+
+puts "Shutting down the peer..."
+@journeta.stop
+
+puts "Exiting."