communicator 0.1.0 → 0.1.1

data/Gemfile.lock

@@ -6,6 +6,7 @@ PATH
       httparty (>= 0.6.1)
       json (>= 1.4.0)
       sinatra (~> 1.1.0)
+      sinatra-basic-auth
 
 GEM
   remote: http://rubygems.org/
@@ -25,6 +26,8 @@ GEM
     sinatra (1.1.0)
       rack (~> 1.1)
       tilt (~> 1.1)
+    sinatra-basic-auth (0.1.0)
+      sinatra
     sqlite3-ruby (1.3.2)
     tilt (1.1)
 
@@ -41,4 +44,5 @@ DEPENDENCIES
   rack-test (>= 0.5.6)
   shoulda (= 2.10.3)
   sinatra (~> 1.1.0)
+  sinatra-basic-auth
   sqlite3-ruby (>= 1.3.0)

data/README.rdoc

@@ -59,6 +59,11 @@ class receives updates from like this:
   class Post < ActiveRecord::Base
     receives_from :post
   end
+  
+If you want to skip some remote attributes and not let them progapate into local instances,
+use `receives_from :post, :except => [:user_id]`.
+
+Attributes that are not physically present in the local database will be skipped automatically.
 
 Use the automatically added `publish` instance method on your models to push changes
 to the other side. They will be enqueued in the local `outbound_messages` table and

data/Rakefile

@@ -54,7 +54,10 @@ namespace :test_server do
     Thread.new do
       # Capture sinatra output (to hide it away...)
       require "open3"
-      Open3.popen3("bundle exec rackup test/config.ru -p 20359 --pid=#{File.join(File.dirname(__FILE__), 'test', 'rack.pid')}")
+      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
+      
     end
     sleep 2.0
   

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/communicator.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{communicator}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Christoph Olszowka"]
@@ -39,11 +39,14 @@ Gem::Specification.new do |s|
      "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"
@@ -56,11 +59,14 @@ Gem::Specification.new do |s|
   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"

data/lib/communicator/active_record_integration.rb

@@ -8,8 +8,18 @@ module Communicator::ActiveRecordIntegration
     #    receives_from :post
     #  end
     #
-    def receives_from(source)
-      Communicator.register_receiver(self, source)
+    def receives_from(source, options={})
+      Communicator.register_receiver(self, source, options)
+    end
+    
+    def skipped_remote_attributes
+      @skipped_remote_attributes ||= []
+    end
+    
+    def skip_remote_attributes(*attr_names)
+      attr_names.each do |attr_name|
+        skipped_remote_attributes << attr_name.to_sym
+      end
     end
   end
   
@@ -24,11 +34,13 @@ module Communicator::ActiveRecordIntegration
     end
     
     # Processes the given message body by applying all contained attributes and their values
-    # and saving
+    # and saving. When the setter instance method is missing on the local record, skip that attribute.
     def process_message(input)
       # When the input is still json, parse it. Otherwise we're assuming it's already a demarshalled hash
       input = JSON.parse(input) if input.kind_of?(String)
       input.each do |attr_name, value|
+        # Exclude skipped attributes
+        next if self.class.skipped_remote_attributes.include?(attr_name.to_sym) or !attributes.has_key?(attr_name)
         self.send("#{attr_name}=", value)
       end
       self.updated_from_message = true

data/lib/communicator/server.rb

@@ -16,12 +16,28 @@ class Communicator::Server < Sinatra::Base
     end
   end
   
-  use Rack::Auth::Basic do |username, password|
-    [username, password] == [Communicator::Server.username, Communicator::Server.password]
+  # use Rack::Auth::Basic do |username, password|
+  #   [username, password] == [Communicator::Server.username, Communicator::Server.password]
+  # end
+  
+  helpers do
+    def protected!
+      unless authorized?
+        response['WWW-Authenticate'] = %(Basic realm="Testing HTTP Auth")
+        throw(:halt, [401, "Not authorized\n"])
+      end
+    end
+
+    def authorized?
+      @auth ||=  Rack::Auth::Basic::Request.new(request.env)
+      @auth.provided? && @auth.basic? && @auth.credentials && @auth.credentials == [Communicator::Server.username, Communicator::Server.password]
+    end
   end
+
   
   # PULL
   get '/messages.json' do
+    protected!
     # Require from_id attribute
     return [409, "Specify from_id!"] unless params[:from_id]
     
@@ -39,6 +55,8 @@ class Communicator::Server < Sinatra::Base
   
   # PUSH
   post '/messages.json' do
+    protected!
+    
     body = request.body.read.strip
     # Make sure a message body is given!
     return [409, "No data given"] if body.length < 2

data/lib/communicator.rb

@@ -20,15 +20,28 @@ module Communicator
     # Register a given class as a receiver from source (underscored name). Will then
     # mix in the instance methods from Communicator::ActiveRecord::InstanceMethods so
     # message processing and publishing functionality is included
-    def register_receiver(target, source)
+    def register_receiver(target, source, options={})
       receivers[source] = target
       target.send(:include, Communicator::ActiveRecordIntegration::InstanceMethods)
+      
+      target.skip_remote_attributes(*options[:except]) if options[:except]
+      
+      target
     end
     
     # Tries to find the receiver for given source, raising Communicator::ReceiverUnknown
     # on failure
     def receiver_for(source)
       return receivers[source] if receivers[source]
+      
+      # If not found in the first place, maybe the class just isn't loaded yet and
+      # thus hasn't registered - let's require all models and try again
+      if defined?(Rails)
+        Dir[File.join(Rails.root, 'app/models/**/*.rb')].each {|model| require model}
+        return receivers[source] if receivers[source]
+      end
+      
+      # When everything else fails, just throw an exception...
       raise Communicator::ReceiverUnknown.new("No receiver registered for '#{source}'")
     end
   end

data/test/config.ru

@@ -9,6 +9,7 @@ require 'communicator'
 
 ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => "db/test_server.sqlite3")  
 require 'lib/post'
+require 'lib/comment'
 
 Communicator::Server.username = 'testuser'
 Communicator::Server.password = 'pwd'

data/test/helper.rb

@@ -16,12 +16,14 @@ require 'factories'
 # Connect to client test database
 ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => "db/test_client.sqlite3")
 require 'lib/post'
+require 'lib/comment'
 
 # Connect to server database too so we can peek into what's happening over there
 class TestServerDatabase < ActiveRecord::Base
   establish_connection(:adapter => 'sqlite3', :database => "db/test_server.sqlite3")  
 end
 require 'lib/test_server_database/post'
+require 'lib/test_server_database/comment'
 require 'lib/test_server_database/inbound_message'
 require 'lib/test_server_database/outbound_message'
 
@@ -39,9 +41,11 @@ class Test::Unit::TestCase
     Communicator::InboundMessage.delete_all
     Communicator::OutboundMessage.delete_all
     Post.delete_all
+    Comment.delete_all
     
     TestServerDatabase::InboundMessage.delete_all
     TestServerDatabase::OutboundMessage.delete_all
     TestServerDatabase::Post.delete_all
+    TestServerDatabase::Comment.delete_all
   end
 end

data/test/lib/comment.rb

@@ -0,0 +1,7 @@
+# A simple class for publishing and receiving messages
+class Comment < ActiveRecord::Base
+  receives_from :comment, :except => [:title]
+  after_save do |r|
+    r.publish unless r.updated_from_message
+  end
+end

data/test/lib/test_server_database/comment.rb

@@ -0,0 +1,4 @@
+# Basic class for introspection of what is happening on the server side
+class TestServerDatabase::Comment < TestServerDatabase
+  set_table_name "comments"
+end

data/test/migrate/20101103120519_create_comments.rb

@@ -0,0 +1,13 @@
+class CreateComments < ActiveRecord::Migration
+  def self.up
+    create_table :comments do |t|
+      t.string   :title, :default => nil
+      t.text     :body, :null => false
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :comments
+  end
+end

data/test/test_client.rb

@@ -121,6 +121,22 @@ class TestClient < Test::Unit::TestCase
       end
     end
     
+    # Make sure attributes skipped with :except are not saved at remote
+    context "PUSHing a new comment" do
+      setup do
+        assert @comment = Comment.create(:title => 'my comment', :body => 'some comment')
+        Communicator::Client.push
+      end
+      
+      should "have created the comment at remote" do
+        assert_equal 'some comment', TestServerDatabase::Comment.first.body
+      end
+      
+      should "have skipped permissions attribute when processing at remote" do
+        assert_nil TestServerDatabase::Comment.first.title
+      end
+    end
+    
     context "when an update message is created at remote" do
       setup do
         @remote_msg = TestServerDatabase::OutboundMessage.create!(:body => {:post => {:id => 25, :title => 'new title', :body => 'remote body'}}.to_json)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: communicator
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Christoph Olszowka
@@ -194,11 +194,14 @@ files:
 - 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
@@ -239,11 +242,14 @@ summary: Data push/pull between apps with local inbound/outbound queue and easy
 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