communicator 0.1.11 → 0.2.0

data/.gitignore

@@ -1,6 +1,8 @@
 ## MAC OS
 .DS_Store
 .bundle
+Gemfile.lock
+.rvmrc
 
 ## TEXTMATE
 *.tmproj
@@ -21,6 +23,7 @@ tmtags
 coverage
 rdoc
 pkg
+tmp
 
 ## PROJECT::SPECIFIC
 db/*.sqlite*

data/README.rdoc

@@ -5,10 +5,9 @@ Rails apps.
 
 == Setup
 
-Install in Rails apps with:
+Install in Rails apps by adding this to your Gemfile:
 
   gem 'communicator'
-  $ bundle install
   
 Import rake tasks in your Rails.root/Rakefile:
 
@@ -98,6 +97,11 @@ When an update is received from a remote side, the message will be stored in
 `inbound_messages` and the received changes will be applied to the local record,
 either updating existing or creating new records.
 
+== Compatibility
+
+Communicator is currently only proven to work on Rails 2 apps using either
+REE, 1.8.7, 1.9.1 or 1.9.2. 
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -1,38 +1,25 @@
-require 'rubygems'
-require 'rake'
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "communicator"
-    gem.summary = %Q{Data push/pull between apps with local inbound/outbound queue and easy publish/process interface}
-    gem.description = %Q{Data push/pull between apps with local inbound/outbound queue and easy publish/process interface}
-    gem.email = "christoph at olszowka de"
-    gem.homepage = "http://github.com/colszowka/communicator"
-    gem.authors = ["Christoph Olszowka"]
-    gem.add_dependency 'sinatra', "~> 1.1.0"
-    gem.add_dependency 'activerecord', "< 3.0.0"
-    gem.add_dependency 'httparty', '>= 0.6.1'
-    gem.add_dependency 'json', '>= 1.4.0'
-    gem.add_development_dependency "shoulda", "2.10.3"
-    gem.add_development_dependency 'factory_girl', ">= 1.2.3"
-    gem.add_development_dependency 'rack-test', ">= 0.5.6"
-    gem.add_development_dependency 'bundler', ">= 1.0.0"
-    gem.add_development_dependency 'sqlite3-ruby', ">= 1.3.0"
-    gem.add_development_dependency 'jeweler', '~> 1.4.0'
-    # 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"
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
 end
 
-
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
 
 namespace :db do
   desc "Drop, create and migrate the test databases"
   task :migrate do
     require 'active_record'
+    require 'logger'
     # Drop existing db
     system "rm db/*.sqlite3"
     dev_null = File.new('/dev/null', 'w')
@@ -51,53 +38,38 @@ end
 namespace :test_server do
   desc "Starts the test server"
   task :start do
-    Thread.new do
-      # Capture sinatra output (to hide it away...)
-      require "open3"
-      rackup = "bundle exec rackup test/config.ru -p 20359 --pid=#{File.join(File.dirname(__FILE__), 'test', 'rack.pid')}"
-      Open3.popen3(rackup)
-      #`#{rackup}` # Uncomment to see actual server output
-      
+    # For background on what is going on here, please have a look at:
+    # http://stackoverflow.com/questions/1993071/how-to-controller-start-kill-a-background-process-server-app-in-ruby
+    # http://stackoverflow.com/questions/224512/redirect-the-puts-command-output-to-a-log-file
+    
+    # Clean up tmp dir and make sure test_server.log file exists
+    Dir["tmp/*"].each {|f| system("rm #{f}")}
+    system("touch tmp/test_server.log")
+    
+    # Dynamically choose a port to use so tests can run concurrently!
+    server_port = 20000+rand(5000)
+    # Write the port into a tempfile so tests can figure out where to run against!
+    File.open('tmp/server_port', "w+") do |f|
+      f.print server_port
     end
-    sleep 2.0
-  
-    Kernel.at_exit do
-      Rake::Task["test_server:stop"].invoke
+    puts "Waiting for test server to start on localhost:#{server_port}"
+    
+    pid = fork do
+      exec "bundle exec thin --debug --log tmp/test_server.log -R test/config.ru -p #{server_port} start"
     end
-  end
 
-  desc "Stops the test server"
-  task :stop do
-    begin
-      pid = File.read(File.join(File.dirname(__FILE__), 'test', 'rack.pid')).strip.chomp
-      `kill -s KILL #{pid}`
-      puts "Killed test server with PID #{pid}"
-    rescue => err
-      puts "Nothing to stop..."
+    sleep 10
+  
+    Kernel.at_exit do
+      system("rm tmp/*")
+      Process.kill "KILL", pid
+      Process.wait pid
     end
   end
-end
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
 end
 
-task :test => :check_dependencies
 # Make sure database and test server are in place when tests start
 task :test => :"db:migrate"
 task :test => :"test_server:start"
-
 task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "communicator #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/communicator.gemspec

@@ -1,115 +1,32 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "communicator/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{communicator}
-  s.version = "0.1.11"
+  s.name        = "communicator"
+  s.version     = Communicator::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Christoph Olszowka"]
+  s.email       = ["christoph at olszowka de"]
+  s.homepage    = "http://github.com/capita/communicator"
+  s.summary     = %Q{Data push/pull between apps with local inbound/outbound queue and easy publish/process interface}
+  s.description = %Q{Data push/pull between apps with local inbound/outbound queue and easy publish/process interface}
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Christoph Olszowka"]
-  s.date = %q{2010-11-19}
-  s.description = %q{Data push/pull between apps with local inbound/outbound queue and easy publish/process interface}
-  s.email = %q{christoph at olszowka de}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     ".rvmrc",
-     "Gemfile",
-     "Gemfile.lock",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "communicator.gemspec",
-     "db/migrate/20101101075419_create_inbound_messages.rb",
-     "db/migrate/20101101075719_create_outbound_messages.rb",
-     "lib/communicator.rb",
-     "lib/communicator/active_record_integration.rb",
-     "lib/communicator/client.rb",
-     "lib/communicator/inbound_message.rb",
-     "lib/communicator/outbound_message.rb",
-     "lib/communicator/server.rb",
-     "lib/communicator/tasks.rb",
-     "test/config.ru",
-     "test/factories.rb",
-     "test/helper.rb",
-     "test/lib/comment.rb",
-     "test/lib/post.rb",
-     "test/lib/test_server_database/comment.rb",
-     "test/lib/test_server_database/inbound_message.rb",
-     "test/lib/test_server_database/outbound_message.rb",
-     "test/lib/test_server_database/post.rb",
-     "test/migrate/20101101093519_create_posts.rb",
-     "test/migrate/20101103120519_create_comments.rb",
-     "test/test_client.rb",
-     "test/test_message_models.rb",
-     "test/test_server.rb"
-  ]
-  s.homepage = %q{http://github.com/colszowka/communicator}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Data push/pull between apps with local inbound/outbound queue and easy publish/process interface}
-  s.test_files = [
-    "test/factories.rb",
-     "test/helper.rb",
-     "test/lib/comment.rb",
-     "test/lib/post.rb",
-     "test/lib/test_server_database/comment.rb",
-     "test/lib/test_server_database/inbound_message.rb",
-     "test/lib/test_server_database/outbound_message.rb",
-     "test/lib/test_server_database/post.rb",
-     "test/migrate/20101101093519_create_posts.rb",
-     "test/migrate/20101103120519_create_comments.rb",
-     "test/test_client.rb",
-     "test/test_message_models.rb",
-     "test/test_server.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.rubyforge_project = "communicator"
+  
+  s.add_dependency 'sinatra', "~> 1.1.0"
+  s.add_dependency 'activerecord', "< 3.0.0"
+  s.add_dependency 'httparty', '>= 0.6.1'
+  s.add_dependency 'json', '>= 1.4.0'
+  s.add_development_dependency "shoulda", "2.10.3"
+  s.add_development_dependency 'factory_girl', ">= 1.2.3"
+  s.add_development_dependency 'rack-test', ">= 0.5.6"
+  s.add_development_dependency 'bundler', ">= 1.0.0"
+  s.add_development_dependency 'sqlite3-ruby', ">= 1.3.0"
+  s.add_development_dependency 'thin'
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<sinatra>, ["~> 1.1.0"])
-      s.add_runtime_dependency(%q<activerecord>, ["< 3.0.0"])
-      s.add_runtime_dependency(%q<httparty>, [">= 0.6.1"])
-      s.add_runtime_dependency(%q<json>, [">= 1.4.0"])
-      s.add_development_dependency(%q<shoulda>, ["= 2.10.3"])
-      s.add_development_dependency(%q<factory_girl>, [">= 1.2.3"])
-      s.add_development_dependency(%q<rack-test>, [">= 0.5.6"])
-      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
-      s.add_development_dependency(%q<sqlite3-ruby>, [">= 1.3.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.4.0"])
-    else
-      s.add_dependency(%q<sinatra>, ["~> 1.1.0"])
-      s.add_dependency(%q<activerecord>, ["< 3.0.0"])
-      s.add_dependency(%q<httparty>, [">= 0.6.1"])
-      s.add_dependency(%q<json>, [">= 1.4.0"])
-      s.add_dependency(%q<shoulda>, ["= 2.10.3"])
-      s.add_dependency(%q<factory_girl>, [">= 1.2.3"])
-      s.add_dependency(%q<rack-test>, [">= 0.5.6"])
-      s.add_dependency(%q<bundler>, [">= 1.0.0"])
-      s.add_dependency(%q<sqlite3-ruby>, [">= 1.3.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.4.0"])
-    end
-  else
-    s.add_dependency(%q<sinatra>, ["~> 1.1.0"])
-    s.add_dependency(%q<activerecord>, ["< 3.0.0"])
-    s.add_dependency(%q<httparty>, [">= 0.6.1"])
-    s.add_dependency(%q<json>, [">= 1.4.0"])
-    s.add_dependency(%q<shoulda>, ["= 2.10.3"])
-    s.add_dependency(%q<factory_girl>, [">= 1.2.3"])
-    s.add_dependency(%q<rack-test>, [">= 0.5.6"])
-    s.add_dependency(%q<bundler>, [">= 1.0.0"])
-    s.add_dependency(%q<sqlite3-ruby>, [">= 1.3.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.4.0"])
-  end
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
 end
-

data/lib/communicator.rb

@@ -66,6 +66,7 @@ require 'communicator/client'
 require 'communicator/active_record_integration'
 require 'communicator/outbound_message'
 require 'communicator/inbound_message'
+require 'communicator/version'
 
 # Autoload config when present for rails
 if defined?(Rails)

data/lib/communicator/client.rb

@@ -5,6 +5,7 @@ class Communicator::Client
   class InvalidStartingId < StandardError; end;
 
   include HTTParty
+  default_timeout 10
   
   class << self
     attr_writer :username, :password
@@ -28,6 +29,10 @@ class Communicator::Client
       verify_response request.response
       Communicator::InboundMessage.create_from_json_collection!(JSON.parse(request.parsed_response))
       request
+      
+    # Customize error message on HTTP Timeout
+    rescue Timeout::Error => err
+      raise Timeout::Error, "Failed to PULL from #{base_uri} - Request timed out!"
     end
   
     def push(from_id=nil)
@@ -45,6 +50,10 @@ class Communicator::Client
       else
         raise "Could not agree upon from_id with server!"
       end
+      
+    # Customize error message on HTTP Timeout
+    rescue Timeout::Error => err
+      raise Timeout::Error, "Failed to PUSH to #{base_uri} - Request timed out!"
     end
     
     def verify_response(response)
@@ -60,4 +69,4 @@ class Communicator::Client
     end
   end
 
-end
+end

data/lib/communicator/version.rb

@@ -0,0 +1,3 @@
+module Communicator
+  VERSION = '0.2.0'
+end

data/test/config.ru

@@ -1,8 +1,7 @@
 require 'bundler'
 Bundler.setup(:default, :development)
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(::File.dirname(__FILE__))
 
 require 'active_record'
 require 'communicator'
@@ -14,4 +13,4 @@ require 'lib/comment'
 Communicator::Server.username = 'testuser'
 Communicator::Server.password = 'pwd'
 
-run Communicator::Server
+run Communicator::Server

data/test/helper.rb

@@ -48,4 +48,13 @@ class Test::Unit::TestCase
     TestServerDatabase::Post.delete_all
     TestServerDatabase::Comment.delete_all
   end
-end
+  
+  # Retrieves the test server port that is generated randomly (see Rakefile)
+  # from the tempfile...
+  def server_port
+    File.read(File.join(File.dirname(__FILE__), '../tmp/server_port')).strip.chomp
+  rescue => err
+    err.message = "Failed to retrieve test server port. Are you sure test server is running? #{err.message}"
+    raise err
+  end
+end

data/test/test_client.rb

@@ -2,8 +2,8 @@ require 'helper'
 
 #
 # Unit tests for client and it's interaction with the real server running in background
-# on port 20359. For introspection purposes, a simple second database connection
-# has been established as TestServerDatabase
+# For introspection purposes, a simple second database connection has been established 
+# as TestServerDatabase
 #
 class TestClient < Test::Unit::TestCase
   context "Without auth credentials configured" do
@@ -28,7 +28,7 @@ class TestClient < Test::Unit::TestCase
     setup do
       Communicator::Client.username = 'testuser'
       Communicator::Client.password = 'pwd'
-      Communicator::Client.base_uri 'localhost:20359'
+      Communicator::Client.base_uri "localhost:#{server_port}"
     end
     
     context "PUSH" do
@@ -132,7 +132,7 @@ class TestClient < Test::Unit::TestCase
         assert_equal 'some comment', TestServerDatabase::Comment.first.body
       end
       
-      should "have skipped permissions attribute when processing at remote" do
+      should "have skipped title attribute when processing at remote" do
         assert_nil TestServerDatabase::Comment.first.title
       end
     end
@@ -159,4 +159,4 @@ class TestClient < Test::Unit::TestCase
       end
     end
   end
-end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: communicator
 version: !ruby/object:Gem::Version 
-  hash: 13
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
   - 0
-  - 1
-  - 11
-  version: 0.1.11
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Christoph Olszowka
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-19 00:00:00 +01:00
+date: 2011-02-09 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -163,40 +163,35 @@ dependencies:
   type: :development
   version_requirements: *id009
 - !ruby/object:Gem::Dependency 
-  name: jeweler
+  name: thin
   prerelease: false
   requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 3
         segments: 
-        - 1
-        - 4
         - 0
-        version: 1.4.0
+        version: "0"
   type: :development
   version_requirements: *id010
 description: Data push/pull between apps with local inbound/outbound queue and easy publish/process interface
-email: christoph at olszowka de
+email: 
+- christoph at olszowka de
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
 - .document
 - .gitignore
-- .rvmrc
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.rdoc
 - Rakefile
-- VERSION
 - communicator.gemspec
 - db/migrate/20101101075419_create_inbound_messages.rb
 - db/migrate/20101101075719_create_outbound_messages.rb
@@ -207,6 +202,7 @@ files:
 - lib/communicator/outbound_message.rb
 - lib/communicator/server.rb
 - lib/communicator/tasks.rb
+- lib/communicator/version.rb
 - test/config.ru
 - test/factories.rb
 - test/helper.rb
@@ -221,13 +217,14 @@ files:
 - test/test_client.rb
 - test/test_message_models.rb
 - test/test_server.rb
+- tmp/.gitignore
 has_rdoc: true
-homepage: http://github.com/colszowka/communicator
+homepage: http://github.com/capita/communicator
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -250,22 +247,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.3.7
+rubyforge_project: communicator
+rubygems_version: 1.4.1
 signing_key: 
 specification_version: 3
 summary: Data push/pull between apps with local inbound/outbound queue and easy publish/process interface
-test_files: 
-- test/factories.rb
-- test/helper.rb
-- test/lib/comment.rb
-- test/lib/post.rb
-- test/lib/test_server_database/comment.rb
-- test/lib/test_server_database/inbound_message.rb
-- test/lib/test_server_database/outbound_message.rb
-- test/lib/test_server_database/post.rb
-- test/migrate/20101101093519_create_posts.rb
-- test/migrate/20101103120519_create_comments.rb
-- test/test_client.rb
-- test/test_message_models.rb
-- test/test_server.rb
+test_files: []
+

data/.rvmrc

@@ -1 +0,0 @@
-rvm use 1.8.7

data/Gemfile.lock

@@ -1,54 +0,0 @@
-PATH
-  remote: .
-  specs:
-    communicator (0.1.10)
-      activerecord (< 3.0.0)
-      httparty (>= 0.6.1)
-      json (>= 1.4.0)
-      sinatra (~> 1.1.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activerecord (2.3.10)
-      activesupport (= 2.3.10)
-    activesupport (2.3.10)
-    crack (0.1.8)
-    factory_girl (1.3.2)
-    gemcutter (0.6.1)
-    git (1.2.5)
-    httparty (0.6.1)
-      crack (= 0.1.8)
-    jeweler (1.4.0)
-      gemcutter (>= 0.1.0)
-      git (>= 1.2.5)
-      rubyforge (>= 2.0.0)
-    json (1.4.6)
-    json_pure (1.4.6)
-    rack (1.2.1)
-    rack-test (0.5.6)
-      rack (>= 1.0)
-    rubyforge (2.0.4)
-      json_pure (>= 1.1.7)
-    shoulda (2.10.3)
-    sinatra (1.1.0)
-      rack (~> 1.1)
-      tilt (~> 1.1)
-    sqlite3-ruby (1.3.2)
-    tilt (1.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord (< 3.0.0)
-  bundler (>= 1.0.0)
-  communicator!
-  factory_girl (>= 1.2.3)
-  httparty (>= 0.6.1)
-  jeweler (>= 1.4.0)
-  json (>= 1.4.0)
-  rack-test (>= 0.5.6)
-  shoulda (= 2.10.3)
-  sinatra (~> 1.1.0)
-  sqlite3-ruby (>= 1.3.0)

data/VERSION

@@ -1 +0,0 @@
-0.1.11