cloud_assets 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in cloud_assets.gemspec
+gemspec

data/README.md

@@ -0,0 +1,86 @@
+cloud_assets enables a Rails app to make transparent use of
+assets on a remote server in an alternative technology.
+
+Principles and modes of operation
+---------------------------------
+
+You can avoid incorporating static assets in your Rails
+app directly, if they exist somewhere else on the internet.
+With cloud_assets you configure your Rails app as the
+front end for assets managed in another internet-connected
+system, e.g. WordPress, Drupal, SharePoint, etc.
+
+Instead of returning a 404 Not Found, cloud_assets will
+proxy a pooled request to the remote server, cache the
+content locally, and serve it from Rails.
+
+cloud_assets also provides tools and vocabulary for making
+Rails views that make use of HTML originating on the
+remote system, and rewrites URIs in such templates to
+point either to the local Rails system or a CDN, depending
+on configuration and utility.
+
+Installation
+------------
+
+1.
+
+  Add cloud_assets to your Gemfile and bundle install, then
+  define the following in your environment.
+
+  Required:
+  CLOUD_ASSET_ORIGIN - Origin URI for remote assets
+
+  Optional:
+  CLOUD_ASSET_CDN - Content delivery network, if any. This
+  is used to rewrite URIs for images and other large static
+  assets to the CDN instead of Rails.
+
+  CLOUD_ASSET_USER, CLOUD_ASSET_PASSWORD - HTTP Basic
+  credentials which will be used when retrieving assets from
+  the cloud asset source.
+
+2.
+
+  Put a route at the bottom of your routes.rb:
+
+  match '*url' => 'cloud_assets#content'
+
+  This will allow cloud_assets to handle anything Rails
+  doesn't recognize.
+
+3.
+
+  In application_controller.rb:
+
+  include CloudAssets
+
+Additional Configuration
+------------------------
+
+If you are serving any non-trivial amount of remotely
+sourced assets out of your Rails system, you'll want a cache.
+cloud_assets likes memcached via dalli.
+
+To enable it, just define $hydra_cache somewhere in one of
+your initializers.
+
+Usage
+-----
+
+Set a remote layout for an HTML view by defining the URI to
+the layout on the remote system, e.g.
+
+  set_remote_layout '/templates/foo.html'
+
+You can inject additional content into the elements of that
+template, or override the interior of its elements, using CSS
+selectors:
+
+  inject_into_remote_layout '#notice' => flash[:notice]
+  override_remote_layout 'body' => yield
+
+Finally, obtain and show the result (complete with rewrites
+of CDN URLs and so on) with:
+
+  apply_remote_layout

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/controllers/cloud_assets_controller.rb

@@ -0,0 +1,34 @@
+class CloudAssetsController < ApplicationController
+
+ def content
+    asset_response = cloud_asset request.fullpath
+    if asset_response.success?
+      content_type = asset_response.headers_hash['Content-type']
+      if content_type.kind_of? Array
+        content_type = content_type.pop
+      end
+      if content_type =~ /text\/html/
+        set_remote_layout asset_response
+        response.headers['Cache-Control'] = 'no-cache, no-store, must-revalidate, max-age=0'
+        render :html => ''
+      elsif content_type =~ /javascript/
+        response.headers['Cache-Control'] = "max-age=#{CloudAssets::javascript_max_age_seconds}"
+        # In externally sourced JS, mask the cloud source to point here
+        # we want to do this because of JavaScript's same-source restrictions
+        body = CloudAssets::fixup_javascript(asset_response.body.gsub CloudAssets::origin,'')
+        send_data body, :type => content_type, :disposition => 'inline'
+      elsif content_type =~ /css/
+        response.headers['Cache-Control'] = "max-age=#{CloudAssets::css_max_age_seconds}"
+        # In externally sourced CSS, mask the cloud source to point to the CDN
+        body = CloudAssets::fixup_css(asset_response.body.gsub CloudAssets::origin, CloudAssets::cdn)
+        send_data body, :type => content_type, :disposition => 'inline'
+      else
+        response.headers['Cache-Control'] = "max-age=#{CloudAssets::other_max_age_seconds}"
+        send_data asset_response.body, :type => content_type, :disposition => 'inline'
+      end
+    else
+      render :status => :not_found
+    end
+  end
+
+end

data/cloud_assets.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "cloud_assets/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cloud_assets"
+  s.version     = CloudAssets::VERSION
+  s.authors     = ["Rob Heittman"]
+  s.email       = ["rob.heittman@solertium.com"]
+  s.homepage    = "https://github.com/rfc2616/cloud_assets"
+  s.summary     = %q{
+    Enables a Rails app to make transparent use of
+    assets on a remote server in an alternative technology.
+  }
+  s.description = %q{
+    This gem is in use in some production sites to provide
+    backing for a Rails app using content from WordPress and
+    PostLaunch (a Java based CMS), and has specific
+    dependencies on Typhoeus, Nokogiri, and dalli, favorites
+    we use at Solertium. It's in the early stages of
+    being made into a general purpose tool -- cleanup,
+    generalized tests (our site-specific ones are stripped
+    from the gem) documentation, performance, and decoupling
+    from dependencies.
+  }
+
+  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"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "typhoeus"
+  s.add_runtime_dependency "nokogiri"
+  s.add_runtime_dependency "dalli"
+end

data/lib/cloud_assets/version.rb

@@ -0,0 +1,3 @@
+module CloudAssets
+  VERSION = "0.0.2"
+end

data/lib/cloud_assets.rb

@@ -0,0 +1,223 @@
+require "cloud_assets/version"
+
+module CloudAssets
+
+  def self.setup
+    yield self
+  end
+
+  # Monkey-patch this method if you need to hack some fixups into
+  # html from your asset source.
+  def self.fixup_html(html)
+    html
+  end
+
+  # Monkey-patch this method if you need to hack some fixups into
+  # javascript from your asset source.
+  def self.fixup_javascript(javascript)
+    javascript
+  end
+
+  # Monkey-patch this method if you need to hack some fixups into
+  # css from your asset source.
+  def self.fixup_css(css)
+    css
+  end
+
+  mattr_accessor :origin
+  @@origin = ENV['CLOUD_ASSET_ORIGIN']
+
+  mattr_accessor :user
+  @@user = ENV['CLOUD_ASSET_USER']
+
+  mattr_accessor :password
+  @@password = ENV['CLOUD_ASSET_PASSWORD']
+
+  mattr_accessor :cdn
+  @@cdn = ENV['CLOUD_ASSET_CDN'] || ''
+
+  # How long objects from the source can be kept in our local cache
+  mattr_accessor :cache_timeout_seconds
+  @@cache_timeout_seconds = 604800
+
+  # How long to allow clients (and CDN) to keep javascript assets
+  mattr_accessor :javascript_max_age_seconds
+  @@javascript_max_age_seconds = 600
+
+  # How long to allow clients (and CDN) to keep css assets
+  mattr_accessor :css_max_age_seconds
+  @@css_max_age_seconds = 600
+
+  # How long to allow clients (and CDN) to keep other assets
+  mattr_accessor :other_max_age_seconds
+  @@other_max_age_seconds = 86400
+
+  mattr_accessor :verbose
+  @@verbose = false
+
+  class Engine < Rails::Engine
+
+     module ControllerMethods
+
+        require 'typhoeus'
+        require 'nokogiri'
+
+        def cloud_asset(path)
+          p = "#{CloudAssets::origin}#{path}"
+          hydra = Typhoeus::Hydra.new
+          unless $dalli_cache.nil?
+            hydra.cache_getter do |request|
+              $dalli_cache.get(request.cache_key) rescue nil
+            end
+            hydra.cache_setter do |request|
+              $dalli_cache.set(request.cache_key, request.response, request.cache_timeout)
+            end
+          end
+          options = {
+            :follow_location => true,
+            :max_redirects => 3,
+            :cache_timeout => CloudAssets::cache_timeout_seconds
+          }
+          unless CloudAssets::user.nil?
+            options[:username] = CloudAssets::user
+            options[:password] = CloudAssets::password
+            options[:auth_method] = :basic
+          end
+          if CloudAssets.verbose
+            puts "Retrieving remote asset #{p}"
+          end
+          request = Typhoeus::Request.new p, options
+          asset_response = nil
+          request.on_complete do |hydra_response|
+            asset_response = hydra_response
+          end
+          hydra.queue request
+          hydra.run
+          asset_response
+        end
+
+        def optimize_uri(src)
+          return nil if src.nil?
+          o = CloudAssets::cdn || ''
+          src.gsub!(CloudAssets::origin,'')
+          return src if src =~ /^http:/
+          "#{o}#{src}"
+        end
+
+        def correct_uri(src)
+          src.gsub(CloudAssets::origin,'')
+        end
+
+        def optimized_html_for(asset_response)
+          doc = Nokogiri::HTML(asset_response.body)
+
+          { 'img' => 'src',
+            'link' => 'href' }.each do |tag,attribute|
+            doc.css(tag).each do |e|
+              if tag == 'link' and e['rel'] != 'stylesheet'
+                next
+              end
+              unless e[attribute].nil?
+                e[attribute] = optimize_uri(e[attribute])
+              end
+            end
+          end
+
+          { 'a' => 'href',
+            'script' => 'src',
+            'link' => 'href' }.each do |tag,attribute|
+            doc.css(tag).each do |e|
+              if tag == 'link' and e['rel'] == 'stylesheet'
+                next
+              end
+              unless e[attribute].nil?
+                e[attribute] = correct_uri(e[attribute])
+              end
+            end
+          end
+
+          doc
+        end
+
+        def inject_into_remote_layout(hash)
+          if @injections.nil?
+            @injections = {}
+          end
+          @injections.merge! hash
+        end
+
+        def override_remote_layout(hash)
+          if @overrides.nil?
+            @overrides = {}
+          end
+          @overrides.merge! hash
+        end
+
+        def set_remote_layout(layout)
+          @remote_layout = layout
+        end
+
+        def set_default_remote_layout(layout)
+          if @remote_layout.nil?
+            @remote_layout = layout
+          end
+        end
+
+        def apply_remote_layout
+          begin
+            if @remote_layout.nil?
+              raise <<-ERR
+                No remote layout is defined. Use set_remote_layout or
+                set_default_remote_layout in your views prior to calling
+                apply_remote_layout.
+              ERR
+            end
+            if @remote_layout.kind_of? String
+              doc = optimized_html_for cloud_asset "#{@remote_layout}"
+            else
+              doc = optimized_html_for @remote_layout
+            end
+            unless @overrides.nil?
+              @overrides.each do |key, value|
+                begin
+                  doc.at_css(key).inner_html = value
+                rescue
+                  puts "Failed to override template element: #{key}"
+                end
+              end
+            end
+            unless @injections.nil?
+              @injections.each do |key, value|
+                begin
+                  doc.at_css(key).add_child(value)
+                rescue
+                  puts "Failed to inject data into template element: #{key}"
+                end
+              end
+            end
+            # We don't know what in-doc references might be to, so we have to make
+            # them local and can't optimize them to the CDN -- at least not without
+            # some serious guessing which we are not ready to do
+            CloudAssets::fixup_html(doc.to_s.gsub CloudAssets::origin, '')
+          rescue => e
+            puts e.inspect
+            puts e.backtrace
+            raise e
+          end
+        end
+
+      end
+
+    initializer 'cloud_assets.app_controller' do |app|
+      ActiveSupport.on_load(:action_controller) do
+        include ControllerMethods
+        helper_method :inject_into_remote_layout
+        helper_method :override_remote_layout
+        helper_method :set_remote_layout
+        helper_method :set_default_remote_layout
+        helper_method :apply_remote_layout
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: cloud_assets
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Rob Heittman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: &70144157060340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70144157060340
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70144157059580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70144157059580
+- !ruby/object:Gem::Dependency
+  name: dalli
+  requirement: &70144157058760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70144157058760
+description: ! "\n    This gem is in use in some production sites to provide\n    backing
+  for a Rails app using content from WordPress and\n    PostLaunch (a Java based CMS),
+  and has specific\n    dependencies on Typhoeus, Nokogiri, and dalli, favorites\n
+  \   we use at Solertium. It's in the early stages of\n    being made into a general
+  purpose tool -- cleanup,\n    generalized tests (our site-specific ones are stripped\n
+  \   from the gem) documentation, performance, and decoupling\n    from dependencies.\n
+  \ "
+email:
+- rob.heittman@solertium.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- app/controllers/cloud_assets_controller.rb
+- app/views/cloud_assets/content.html.erb
+- cloud_assets.gemspec
+- lib/cloud_assets.rb
+- lib/cloud_assets/version.rb
+homepage: https://github.com/rfc2616/cloud_assets
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Enables a Rails app to make transparent use of assets on a remote server
+  in an alternative technology.
+test_files: []