rails_bridge 0.0.5

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,21 @@
+source "http://rubygems.org"
+
+gem "activesupport"
+gem 'typhoeus', '~> 0.2.0'
+gem 'rails_bridge', :require=>'rails_bridge', :path=>'.'
+gem 'wdd-ruby-ext', '~> 0.2.3'
+
+# gem 'ruby-debug19'
+
+group :test, :development do
+  gem 'rails', '>= 3.0'
+  gem 'jeweler'
+  gem "sqlite3-ruby", :require => "sqlite3"
+  gem "capybara", :git=>'https://github.com/jnicklas/capybara.git', :branch=>'master'
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem 'eventmachine'
+  gem 'dalli'
+  gem 'syntax'
+  gem 'tm_helper', :path=>"/Users/billdoughty/src/capitalthought/tm_helper"
+end

data/Gemfile.lock

@@ -0,0 +1,154 @@
+GIT
+  remote: https://github.com/jnicklas/capybara.git
+  revision: af9dd3670419b3e39743e1b15bb271b6aaf4dc15
+  branch: master
+  specs:
+    capybara (0.4.0)
+      celerity (>= 0.7.9)
+      culerity (>= 0.2.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (>= 0.0.27)
+      xpath (~> 0.1.2)
+
+PATH
+  remote: .
+  specs:
+    rails_bridge (0.0.4)
+      activesupport
+      rails_bridge
+      typhoeus (~> 0.2.0)
+      wdd-ruby-ext (~> 0.2.3)
+
+PATH
+  remote: /Users/billdoughty/src/capitalthought/tm_helper
+  specs:
+    tm_helper (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.3)
+      actionpack (= 3.0.3)
+      mail (~> 2.2.9)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+    activesupport (3.0.3)
+    arel (2.0.6)
+    builder (2.1.2)
+    celerity (0.8.6)
+    childprocess (0.1.6)
+      ffi (~> 0.6.3)
+    culerity (0.2.13)
+    dalli (1.0.0)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    eventmachine (0.12.10)
+    ffi (0.6.3)
+      rake (>= 0.8.7)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json_pure (1.4.6)
+    mail (2.2.13)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    nokogiri (1.4.4)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rails (3.0.3)
+      actionmailer (= 3.0.3)
+      actionpack (= 3.0.3)
+      activerecord (= 3.0.3)
+      activeresource (= 3.0.3)
+      activesupport (= 3.0.3)
+      bundler (~> 1.0)
+      railties (= 3.0.3)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    rspec-rails (2.3.1)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.3.0)
+    rubyzip (0.9.4)
+    selenium-webdriver (0.1.2)
+      childprocess (~> 0.1.5)
+      ffi (~> 0.6.3)
+      json_pure
+      rubyzip
+    sqlite3-ruby (1.3.2)
+    syntax (1.0.0)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    typhoeus (0.2.0)
+    tzinfo (0.3.23)
+    wdd-ruby-ext (0.2.3)
+    xpath (0.1.2)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  capybara!
+  dalli
+  eventmachine
+  jeweler
+  rails (>= 3.0)
+  rails_bridge!
+  rspec
+  rspec-rails
+  sqlite3-ruby
+  syntax
+  tm_helper!
+  typhoeus (~> 0.2.0)
+  wdd-ruby-ext (~> 0.2.3)

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2010 Capital Thought, LLC
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use any part of this software or its source code except
+in compliance with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.rdoc

@@ -0,0 +1,244 @@
+= RailsBridge
+
+* http://github.com/capitalthought/rails_bridge
+
+== DESCRIPTION
+
+Easy embedding of remote content into your Rails app, plus exporting of your Rails layouts templatized for other languages (such as PHP).
+
+== SYNOPSIS
+
+RailsBridge has two components.
+
+=== RailsBridge::ContentBridge
+Allows for easy embedding of content from a remote server directly into the HTML, XML, or Javascript returned by your Rails application.  The remote server may be an external application, a web service, or any other resource available via HTTP on the network.  
+=== RailsBridge::LayoutBridge
+Allows easy exporting of your Rails HTML layouts as templates for other applications.
+---
+== INSTALLATION
+
+rails_bridge is installed as a Ruby gem.  
+
+  gem install rails_bridge
+
+Include the gem in your Gemfile.
+
+  gem 'rails_bridge'
+
+---
+
+== CONTENT BRIDGE
+
+The content bridge is used to retrieve and cache content from external HTTP servers.  This is achieved by defining and executing content requests.  Requests are defined using the RailsBridge::ContentBridge class.
+
+=== Up and Running in 5 minutes
+
+* Install the gem in your Rails app.
+* Generate a content bridge using the provided Rails generator
+  rails g content_bridge twitter_status_cacher
+  
+* Edit the generated class file (app/rails_bridge/content_bridges/twitter_status_cacher.rb).  The following shows an example.
+
+    require 'json'
+  
+    class TwitterStatusCacher < RailsBridge::ContentBridge
+      self.request_timeout = 1000     # miliseconds
+      self.cache_timeout   = 60       # seconds
+      self.host            = 'api.twitter.com'
+      self.path            = '/statuses/user_timeline.json'
+      self.default_content = '<<Twitter unavailable>>'
+      self.on_success {|content| JSON.parse(content).first["text"]}
+    end
+
+* In your controller:
+  @soopa_latest_tweet = TwitterStatusCacher.get_remote_content(:params=>{:screen_name => 'soopa'})
+  
+That's it!  If the request time's out before 1 second, "<<Twitter unavailable>>" will be returned instead.
+If the request succeeds, the content will be cached locally for 60 seconds and returned for each
+subsequent call to 
+  TwitterStatusCacher.get_remote_content(:params=>{:screen_name => 'soopa'})
+
+There are other more flexible ways to define reusable content requests. Read on for more details.
+
+=== Defining reusable requests
+
+Reusable requests can be defined on the ContentBridge class:
+
+  RailsBridge::ContentBridge.content_request( :server_com ) do |request|
+    request.protocol        = 'http'  # can be 'http' or 'https'.  'http' is the default
+    request.host            = "server.com"
+    request.port            = 8080 # default is 80
+    request.path            = "/some/path"
+    request.params          = {:param1=>'a value', :param2=>'another value'}  # URL query params
+    request.default_content = "Content unavailable at this time."
+    request.request_timeout = 1000 # miliseconds
+    request.cache_timeout   = 5000 # seconds
+  end
+  
+These requests can then be executed using the automatically generated class method:
+
+  content = RailsBridge::ContentBridge.get_server_com
+  
+This issues an HTTP GET to "http://server.com:8080/some/path?param1=a%20value&param2=another%20value" and returns the content.  If the server is unavailable or returns an error, or if the request times out, the default content is returned instead.
+
+You can also simply use the url method to define the +protocol+, +host+, +port+, +path+, and +params+  values of a request.  The following declaration is equivalent to the definition above.
+
+  RailsBridge::ContentBridge.content_request( :server_com ) do |request|
+    request.url = "http://server.com:8080/some/path?p1=value"
+    request.default_content = "Content unavailable at this time."
+    request.request_timeout = 1000 # miliseconds
+    request.cache_timeout   = 5000 # seconds
+  end
+  
+=== Pre-processing returned content
+
+You may pre-process the content returned by a request by defining an +on_success+ block.  The remote content is passed as a parameter and the return value of the block is used in place of the original content.  
+
+RailsBridge::ContentBridge.content_request( :server_com ) do |request|
+  request.url = "http://server.com:8080/some/path"
+  request.params = {:param1=>'a value', :param2=>'another value'}
+  request.default_content = "Content unavailable at this time."
+  request.request_timeout = 1000 # miliseconds
+  request.on_success {|content| JSON.parse(content)}
+end
+
+=== Caching
+
+Content is automatically cached if a cache timeout is defined for the request.
+
+  RailsBridge::ContentBridge.content_request( :server_com ) do |request|
+    request.url = "http://server.com:8080/some/path"
+    request.params = {:param1=>'a value', :param2=>'another value'}
+    request.default_content = "Content unavailable at this time."
+    request.request_timeout = 1000 # miliseconds
+    request.cache_timeout = 3600 # seconds
+  end
+    
+  content = RailsBridge::ContentBridge.get_server_com
+
+The content returned from first request will be cached for 3600 seconds.  Subsequent requests issued during that time will return the cached content.  
+
+To explicitly skip the cache, override the cache_timeout with a value of 0.  This will also remove any entry in the cache for this request.
+
+  content = RailsBridge::ContentBridge.get_server_com( :cache_timeout=>0 )
+
+The cache key is derived from the complete URL of the request, including query params, so each request with a unique URL is cached independently.
+
+When RailsBridge is loaded in a Rails application, the configured Rails cache is used by default.  When loaded outside Rails, ActiveSupport::Cache::MemoryStore is used by default.
+
+=== One-line requests
+
+If desired, all of the above functionality can be achieved in one line:
+
+  content = RailsBridge::ContentBridge.get_remote_content("http://server.com:8080/some/path?param1=a%20value&param2=another%20value", {:cache_timeout=>3600, :default_content=>"Content Unavailable", :request_timeout=>1000} )
+
+=== Setting defaults for a group of requests.
+
+Default values can be set for a group of requests by sub-classing RailsBridge::ContentBridge and defining them on the class:
+
+  class TwitterStatusCacher < RailsBridge::ContentBridge
+    self.request_timeout = 500    # miliseconds
+    self.cache_timeout   = 60     # seconds
+    self.host            = 'api.twitter.com'
+    self.path            = '/statuses/user_timeline.json'
+    self.on_success {|content| JSON.parse(content)}
+    
+    content_request( :hoonpark ) {|r| r.params = {:screen_name => 'hoonpark'}}
+    content_request( :soopa ) {|r| r.params = {:screen_name => 'soopa'}}
+  end
+  
+  soopa_latest_tweet = TwitterStatusCacher.get_soopa.first
+  hoonpark_latest_tweet = TwitterStatusCacher.get_hoonpark.first
+  
+=== Setting global defaults
+
+Global default values can be set directly on the RailsBridge::ContentBridge class.  They are used by all inheriting sub-classes unless overridden by the sub-class.
+
+  RailsBridge::ContentBridge.logger = Logger.new(STDOUT)
+  RailsBridge::ContentBridge.cache = ActiveSupport::Cache::MemCacheStore(:compress => true)
+  RailsBridge::ContentBridge.cache_timeout = 5.minutes
+  RailsBridge::ContentBridge.request_timeout = 500 # miliseconds
+  
+I recommend putting these declaration in an initializer file under config/initializers.  For example config/initializers/content_bridge.rb.
+  
+=== Overriding request values on execution
+
+All defined values for a request can be overridden at runtime by passing them in as options to the get method:
+
+  content = RailsBridge::ContentBridge.get_server_com( :params=>{:p1=>'p1'}, :request_timeout=>2000, :cache_timeout=>0 )
+  
+=== Using the provided Rails generator to create ContentBridge classes.
+
+A generator is included named 'content_bridge' that automates generation of content bridge classes in your application.
+
+eg.
+  rails g content_bridge my_content_bridge my_request
+  
+will create a class named +MyContentBridge+ containing a prototype request definition named +my_request+ and place it under _app/rails_bridge/content_bridges.
+
+=== Loading your content bridge classes
+
+All classes under app/rails_bridge/content_bridges will be loaded automatically during application initialization and reloaded when in running in development.
+
+---
+
+== LAYOUT BRIDGE
+
+The layout bridge lets you export your Rails application layouts templatized for other languages.  A controller is automatically included in your app when the 'rails_bridge' gem is installed.  You can access it at:
+
+  http://app_hostname/rails_bridge/layouts
+
+This will show you all of your applications available layouts.  To view a layout without content, click the link of one of the layouts.  You will see the entire HTML layout with no content.  To insert templating content, implement a view for that layout as app/rails_bridge/layouts/<layout_name>/content.html.erb.
+
+In that view, define content for your content_for's and provide the template code to be yielded to the main content area of your layout.
+
+Also, any partials that exist under app/rails_bridge/views will take precedence over those in your normal views directory.  Take advantage of this to override content for layout partials when rendering your templatized layout.
+
+---
+
+== TODO
+
+* Create a ContentBridge class method to purge the cache.
+* Put the pre-processor block after the cache get so it can assign to variables on each execution.
+* Create a Rake task to export LayoutBridge layouts from the command line.
+* Add test to verify partial precedence and content precedence for layout bridge.
+
+== DEVELOPMENT
+
+RailsBridge was developed and tested using Ruby v1.9.2 and Rails v3.0.3.  It uses the Typhoeus gem to handle all HTTP requests.  
+
+You may download the source from Github at http://github.com/capitalthought/rails_bridge.  
+
+You can start an IRB session with the RailsBridge code loaded and initialized by running:
+
+  script/console
+  
+
+=== TESTS
+
+RSpec 2.x is used for the Rails Bridge test suite.  To run the suite:
+
+  rake
+  
+or
+  rake spec
+  
+NOTE: The test suite has an additional dependency on the eventmachine gem to to implement the test HTTP server.
+
+---
+
+== LICENSE
+
+  Copyright 2010 Capital Thought, LLC
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use any part of this software or its source code except 
+  in compliance with the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rails_bridge"
+    gem.summary = %Q{Bridges Rails with an external application.}
+    gem.description = %Q{Allows for easy embedding of content from a remote HTTP server and exporting of the Rails HTML layout into another template.}
+    gem.email = "billdoughty@capitalthought.com"
+    gem.homepage = "http://github.com/capitalthought/rails_bridge"
+    gem.authors = ["shock"]
+    gem.add_development_dependency "typhoeus", "~> 0.2.0"
+    gem.add_development_dependency "activesupport", ">= 2.3.8"    
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new( :spec ) do |t|
+  t.pattern = Dir.glob('spec/**/*_spec.rb')
+  t.rspec_opts = '--format progress'
+#  t.rcov = true
+end
+
+task :default => :spec
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsBridge'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+