rails_bridge 0.0.5

data/spec/dummy/public/javascripts/rails.js

@@ -0,0 +1,175 @@
+(function() {
+  // Technique from Juriy Zaytsev
+  // http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/
+  function isEventSupported(eventName) {
+    var el = document.createElement('div');
+    eventName = 'on' + eventName;
+    var isSupported = (eventName in el);
+    if (!isSupported) {
+      el.setAttribute(eventName, 'return;');
+      isSupported = typeof el[eventName] == 'function';
+    }
+    el = null;
+    return isSupported;
+  }
+
+  function isForm(element) {
+    return Object.isElement(element) && element.nodeName.toUpperCase() == 'FORM'
+  }
+
+  function isInput(element) {
+    if (Object.isElement(element)) {
+      var name = element.nodeName.toUpperCase()
+      return name == 'INPUT' || name == 'SELECT' || name == 'TEXTAREA'
+    }
+    else return false
+  }
+
+  var submitBubbles = isEventSupported('submit'),
+      changeBubbles = isEventSupported('change')
+
+  if (!submitBubbles || !changeBubbles) {
+    // augment the Event.Handler class to observe custom events when needed
+    Event.Handler.prototype.initialize = Event.Handler.prototype.initialize.wrap(
+      function(init, element, eventName, selector, callback) {
+        init(element, eventName, selector, callback)
+        // is the handler being attached to an element that doesn't support this event?
+        if ( (!submitBubbles && this.eventName == 'submit' && !isForm(this.element)) ||
+             (!changeBubbles && this.eventName == 'change' && !isInput(this.element)) ) {
+          // "submit" => "emulated:submit"
+          this.eventName = 'emulated:' + this.eventName
+        }
+      }
+    )
+  }
+
+  if (!submitBubbles) {
+    // discover forms on the page by observing focus events which always bubble
+    document.on('focusin', 'form', function(focusEvent, form) {
+      // special handler for the real "submit" event (one-time operation)
+      if (!form.retrieve('emulated:submit')) {
+        form.on('submit', function(submitEvent) {
+          var emulated = form.fire('emulated:submit', submitEvent, true)
+          // if custom event received preventDefault, cancel the real one too
+          if (emulated.returnValue === false) submitEvent.preventDefault()
+        })
+        form.store('emulated:submit', true)
+      }
+    })
+  }
+
+  if (!changeBubbles) {
+    // discover form inputs on the page
+    document.on('focusin', 'input, select, texarea', function(focusEvent, input) {
+      // special handler for real "change" events
+      if (!input.retrieve('emulated:change')) {
+        input.on('change', function(changeEvent) {
+          input.fire('emulated:change', changeEvent, true)
+        })
+        input.store('emulated:change', true)
+      }
+    })
+  }
+
+  function handleRemote(element) {
+    var method, url, params;
+
+    var event = element.fire("ajax:before");
+    if (event.stopped) return false;
+
+    if (element.tagName.toLowerCase() === 'form') {
+      method = element.readAttribute('method') || 'post';
+      url    = element.readAttribute('action');
+      params = element.serialize();
+    } else {
+      method = element.readAttribute('data-method') || 'get';
+      url    = element.readAttribute('href');
+      params = {};
+    }
+
+    new Ajax.Request(url, {
+      method: method,
+      parameters: params,
+      evalScripts: true,
+
+      onComplete:    function(request) { element.fire("ajax:complete", request); },
+      onSuccess:     function(request) { element.fire("ajax:success",  request); },
+      onFailure:     function(request) { element.fire("ajax:failure",  request); }
+    });
+
+    element.fire("ajax:after");
+  }
+
+  function handleMethod(element) {
+    var method = element.readAttribute('data-method'),
+        url = element.readAttribute('href'),
+        csrf_param = $$('meta[name=csrf-param]')[0],
+        csrf_token = $$('meta[name=csrf-token]')[0];
+
+    var form = new Element('form', { method: "POST", action: url, style: "display: none;" });
+    element.parentNode.insert(form);
+
+    if (method !== 'post') {
+      var field = new Element('input', { type: 'hidden', name: '_method', value: method });
+      form.insert(field);
+    }
+
+    if (csrf_param) {
+      var param = csrf_param.readAttribute('content'),
+          token = csrf_token.readAttribute('content'),
+          field = new Element('input', { type: 'hidden', name: param, value: token });
+      form.insert(field);
+    }
+
+    form.submit();
+  }
+
+
+  document.on("click", "*[data-confirm]", function(event, element) {
+    var message = element.readAttribute('data-confirm');
+    if (!confirm(message)) event.stop();
+  });
+
+  document.on("click", "a[data-remote]", function(event, element) {
+    if (event.stopped) return;
+    handleRemote(element);
+    event.stop();
+  });
+
+  document.on("click", "a[data-method]", function(event, element) {
+    if (event.stopped) return;
+    handleMethod(element);
+    event.stop();
+  });
+
+  document.on("submit", function(event) {
+    var element = event.findElement(),
+        message = element.readAttribute('data-confirm');
+    if (message && !confirm(message)) {
+      event.stop();
+      return false;
+    }
+
+    var inputs = element.select("input[type=submit][data-disable-with]");
+    inputs.each(function(input) {
+      input.disabled = true;
+      input.writeAttribute('data-original-value', input.value);
+      input.value = input.readAttribute('data-disable-with');
+    });
+
+    var element = event.findElement("form[data-remote]");
+    if (element) {
+      handleRemote(element);
+      event.stop();
+    }
+  });
+
+  document.on("ajax:after", "form", function(event, element) {
+    var inputs = element.select("input[type=submit][disabled=true][data-disable-with]");
+    inputs.each(function(input) {
+      input.value = input.readAttribute('data-original-value');
+      input.removeAttribute('data-original-value');
+      input.disabled = false;
+    });
+  });
+})();

data/spec/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/dummy/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path("../../config/environment", __FILE__)
+require 'rspec/rails'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+  
+  
+  # Only run focus tests, if any, or all tests if none.
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+  
+end

data/spec/integration/content_bridge_spec.rb

@@ -0,0 +1,82 @@
+require File.join(File.dirname(__FILE__),'..','spec_helper')
+
+describe RailsBridge::ContentBridge do
+  
+  include ContentBridgeSpecHelper
+  
+  before(:each) do 
+    ContentBridgeTest.request_timeout = 2000
+    TestServer.startup(TEST_SERVER_PORT)
+  end
+
+  after(:each) do
+    TestServer.shutdown
+  end
+  
+  it "verify the TestServer is running" do
+    response = Typhoeus::Request.get("http://localhost:#{TEST_SERVER_PORT}/hi?return_data=verified")
+    response.body.should == 'verified'
+  end
+  
+  it ":get_remote_content fetches by explicit URL" do
+    ContentBridgeTest.get_remote_content("http://localhost:#{TEST_SERVER_PORT}/")
+  end
+  
+  it "fetches the server's content" do
+    ContentBridgeTest.get_chang.should == DEFAULT_RETURN_DATA
+  end
+
+  it "honors the bridge's request_timeout on a hung connection" do
+    cbt = ContentBridgeTest
+    wang = ContentBridgeTest.content_requests[:chang].dup
+    wang.params = wang.params.merge(:sleep=>2)
+    cbt.content_requests[:wang] = wang
+    cbt.request_timeout = 10
+    cbt.get_wang().should == wang.default_content
+  end
+
+  it "honors the request's request_timeout on a hung connection" do
+    cbt = ContentBridgeTest
+    cbt.request_timeout = 4000
+    cbt.get_chang(:params=>{:sleep=>20},:request_timeout=>10).should == cbt.content_requests[:chang].default_content
+  end
+  
+  it "does not cache a request's content when the cache_timeout is 0 or nil" do
+    cbt = ContentBridgeTest
+    cbt.get_chang(:cache_timeout=>0).should == DEFAULT_RETURN_DATA
+    TestServer.shutdown
+    cbt.get_chang(:cache_timeout=>0,:request_timeout=>10).should == cbt.content_requests[:chang].default_content
+    TestServer.startup(TEST_SERVER_PORT)
+    cbt.get_chang(:cache_timeout=>0).should == DEFAULT_RETURN_DATA
+    TestServer.shutdown
+    cbt.get_chang(:cache_timeout=>0,:request_timeout=>10).should == cbt.content_requests[:chang].default_content
+  end
+
+  it "caches a request's content when the cache_timeout is > 0" do
+    unique = __LINE__
+    cbt = ContentBridgeTest
+    chang = cbt.content_requests[:chang]
+    cbt.get_chang(:cache_timeout=>60,:params=>chang.params.merge(:unique=>unique)).should == DEFAULT_RETURN_DATA
+    TestServer.shutdown
+    cbt.get_chang(:cache_timeout=>60,:params=>chang.params.merge(:unique=>unique)).should == DEFAULT_RETURN_DATA
+  end
+
+  it "the cache expires correctly" do
+    unique = __LINE__
+    cbt = ContentBridgeTest
+    chang = cbt.content_requests[:chang]
+    cbt.get_chang(:cache_timeout=>2,:params=>chang.params.merge(:unique=>unique)).should == DEFAULT_RETURN_DATA
+    TestServer.shutdown
+    cbt.get_chang(:cache_timeout=>2,:params=>chang.params.merge(:unique=>unique)).should == DEFAULT_RETURN_DATA
+    sleep 2
+    cbt.get_chang(:cache_timeout=>2,:params=>chang.params.merge(:unique=>unique)).should == cbt.content_requests[:chang].default_content
+  end
+  
+  it "allows get_remote_content to be called directly with request options" do
+    ContentBridgeTest.get_remote_content(DEFAULT_REQUEST_VALUES).should == DEFAULT_RETURN_DATA
+  end
+  
+  it "automatically loads class in the app/rails_bridge/content_bridges directory" do
+    defined?( TwitterContentBridge ).should == 'constant'
+  end
+end

data/spec/integration/engine_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe "initialize test" do
+  it "verify the Dummy app gets loaded" do
+    Rails.application.kind_of?( Dummy::Application ).should == true
+  end
+
+  it "verify the LayoutBridgeController class is loaded" do
+    defined?( RailsBridge::LayoutBridgeController ).should == "constant"
+  end
+
+  it "sets the ContentBridge logger to the Rails logger" do
+    Rails.logger.should_receive(:info)
+    RailsBridge::ContentBridge.logger.info "test"
+  end
+
+  it "sets the ContentBridge cache to Rails cache" do
+    Rails.cache.should_receive(:set)
+    RailsBridge::ContentBridge.cache.set( "key", "value" )
+  end
+
+  it "autoloads classes in the app/rails_bridge path" do
+    defined?( TwitterContentBridge ).should == "constant"
+  end
+end

data/spec/requests/layout_bridge_controller_spec.rb

@@ -0,0 +1,16 @@
+require File.join(File.dirname(__FILE__),'..','spec_helper')
+
+describe RailsBridge::LayoutBridgeController do
+  
+  include LayoutBridgeSpecHelper
+  
+  it "the index action returns the applications layouts" do
+    visit rails_bridge_layouts_path
+    puts page.source
+  end
+
+  it "the show action returns the specified layout" do
+    visit rails_bridge_layout_path(:id=>'application')
+    puts page.source
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,62 @@
+# Configure Rails Envinronment
+require "rubygems"
+require "bundler/setup"
+require 'tm_helper'
+
+ENV["RAILS_ENV"] = "test"
+
+LOG_TO_STDOUT = ENV["LOG_TO_STDOUT"]
+
+def application_test?
+  ENV['TM_FILEPATH'] =~ /integration/ || \
+  ENV['TM_FILEPATH'] =~ /requests/
+end
+
+if TmHelper.running_in_textmate? && !application_test?
+  require File.join(File.dirname(__FILE__),'..','lib','rails_bridge')
+else
+  require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+  require "rails/test_help"
+  require "rspec/rails"
+  require 'capybara/rspec'
+  Capybara.app = Dummy::Application
+      
+  ActionMailer::Base.delivery_method = :test
+  ActionMailer::Base.perform_deliveries = true
+  ActionMailer::Base.default_url_options[:host] = "test.com"
+
+  Rails.backtrace_cleaner.remove_silencers!
+
+  # Configure capybara for integration testing
+  require "capybara/rails"
+  Capybara.default_driver   = :rack_test
+  Capybara.default_selector = :css
+
+  # Run any available migration
+  ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__)
+
+end
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+TestServer.logger = RailsBridge::ContentBridge.logger
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  # config.use_transactional_fixtures = false
+  # config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+  
+end

data/spec/support/content_bridge_helper.rb

@@ -0,0 +1,26 @@
+module ContentBridgeSpecHelper
+  DEFAULT_RETURN_DATA = "RETURN DATA"
+  
+  TEST_SERVER_PORT=1234
+  
+  DEFAULT_REQUEST_VALUES = {
+    :protocol => 'http', 
+    :host => 'localhost', 
+    :port => TEST_SERVER_PORT, 
+    :path => '/path', 
+    :params => {:return_data=>DEFAULT_RETURN_DATA}, 
+    :default_content => 'Request Default Content',
+    :cache_timeout => 0
+  }
+
+  class ContentBridgeTest < RailsBridge::ContentBridge
+    content_request :chang do |request|
+      request.protocol = DEFAULT_REQUEST_VALUES[:protocol]
+      request.host = DEFAULT_REQUEST_VALUES[:host]
+      request.port = DEFAULT_REQUEST_VALUES[:port]
+      request.path = DEFAULT_REQUEST_VALUES[:path]
+      request.params = DEFAULT_REQUEST_VALUES[:params]
+      request.default_content = DEFAULT_REQUEST_VALUES[:default_content]
+    end
+  end
+end

data/spec/support/layout_bridge_helper.rb

@@ -0,0 +1,2 @@
+module LayoutBridgeSpecHelper
+end

data/spec/support/rails_bridge_helper.rb

@@ -0,0 +1,12 @@
+log_filename = File.join(File.dirname(__FILE__),'..','..','log',"#{ENV["RAILS_ENV"]}.log")
+
+if defined?(LOG_TO_STDOUT) && LOG_TO_STDOUT
+  logger = Logger.new(STDOUT)
+else
+  logger = Logger.new(File.open(log_filename,'a'))
+end
+
+if defined? Rails
+  Rails.logger = logger
+end
+RailsBridge::ContentBridge.logger = logger