RubyGems - cobranding - Versions diffs - 1.2.2 - Mend

cobranding 1.2.2

Files changed (12) hide show

data/License.txt +674 -0
data/README.rdoc +69 -0
data/Rakefile +37 -0
data/lib/cobranding.rb +11 -0
data/lib/cobranding/helper.rb +28 -0
data/lib/cobranding/layout.rb +208 -0
data/lib/cobranding/persistent_layout.rb +53 -0
data/spec/helper_spec.rb +98 -0
data/spec/layout_spec.rb +151 -0
data/spec/persistent_layout_spec.rb +111 -0
data/spec/spec_helper.rb +34 -0
metadata +106 -0

@@ -0,0 +1,151 @@
+require File.expand_path('../spec_helper', __FILE__)
+describe Cobranding::Layout do
+  before :each do
+    @context = Object.new
+    def @context.test_tag_for_cobranding
+      "Woo woo"
+    end
+    cache = ActiveSupport::Cache::MemoryStore.new
+    Rails.stub!(:cache).and_return(cache)
+  end
+  it "should be able to evaluate a template from HTML" do
+    layout = Cobranding::Layout.new("<html>Test</html>")
+    layout.evaluate(@context).should == "<html>Test</html>"
+  end
+  it "should replace {{}} markup with predefined method calls" do
+    layout = Cobranding::Layout.new("<html>Test {{test_tag}}</html>")
+    layout.evaluate(@context).should == "<html>Test Woo woo</html>"
+  end
+  it "should replace {{}} markup with predefined method calls using a custom suffix" do
+    def @context.test_tag_for_layout
+      "custom suffix"
+    end
+    layout = Cobranding::Layout.new("<html>Test {{test_tag}}</html>")
+    layout.evaluate(@context, :suffix => "_for_layout").should == "<html>Test custom suffix</html>"
+  end
+  it "should replace {{}} markup with predefined method calls using a custom prefix" do
+    def @context.cobranding_test_tag
+      "custom prefix"
+    end
+    layout = Cobranding::Layout.new("<html>Test {{test_tag}}</html>")
+    layout.evaluate(@context, :prefix => "cobranding_").should == "<html>Test custom prefix</html>"
+  end
+  it "should replace {{}} markup with predefined method calls using a custom prefix and suffix" do
+    def @context.cobranding_test_tag_for_layout
+      "custom prefix and suffix"
+    end
+    layout = Cobranding::Layout.new("<html>Test {{test_tag}}</html>")
+    layout.evaluate(@context, :prefix => "cobranding_", :suffix => "_for_layout").should == "<html>Test custom prefix and suffix</html>"
+  end
+  it "should ignore spaces in {{}} markup tags" do
+    layout = Cobranding::Layout.new("<html>Test {{   test_tag  }}</html>")
+    layout.evaluate(@context).should == "<html>Test Woo woo</html>"
+  end
+  it "should ignore method calls that are not defined" do
+    layout = Cobranding::Layout.new("<html>Test {{no_tag}}</html>")
+    layout.evaluate(@context).should == "<html>Test </html>"
+  end
+  it "should not allow malicious markup tags" do
+    layout = Cobranding::Layout.new("<html>Test {{test_tag; File.read('/etc/passwd')}}</html>")
+    layout.evaluate(@context).should == "<html>Test {{test_tag; File.read('/etc/passwd')}}</html>"
+  end
+  it "should strip extra new lines since they are stupid" do
+    layout = Cobranding::Layout.new("<html>Test\r\n\t  \n Newline\n\n\n</html>")
+    layout.evaluate(@context).should == "<html>Test\n Newline\n</html>"
+  end
+  it "should escape ERB code so evil things can't happen" do
+    layout = Cobranding::Layout.new("<html>Test <%= File.read('/etc/passwd') %></html>")
+    layout.evaluate(@context).should == "<html>Test &lt;%= File.read('/etc/passwd') %&gt;</html>"
+  end
+  it "should be able to get a layout from a URL" do
+    stub_request(:get, "localhost/layout?site=1").to_return(:status => [200, "Success"], :body => "<html>{{test_tag}}</html>")
+    layout = Cobranding::Layout.get("http://localhost/layout", :params => {:site => 1})
+    layout.evaluate(@context).should == "<html>Woo woo</html>"
+  end
+  it "should be able to get a layout from URL components" do
+    stub_request(:get, "https://localhost:444/layout/path?site=1").to_return(:status => [200, "Success"], :body => "<html>{{test_tag}}</html>")
+    layout = Cobranding::Layout.get("path", :scheme => "https", :host => "localhost", :port => 444, :base => "/layout", :params => {:site => 1})
+    layout.evaluate(@context).should == "<html>Woo woo</html>"
+  end
+  it "should be able to get a layout from a URL with a POST" do
+    stub_request(:post, "localhost/layout").with(:params => {"site" => "1"}, :headers => {'Content-Type'=>'application/x-www-form-urlencoded'}).to_return(:status => [200, "Success"], :body => "<html>{{test_tag}}</html>")
+    layout = Cobranding::Layout.get("http://localhost/layout", :method => :post, :site => 1)
+    layout.evaluate(@context).should == "<html>Woo woo</html>"
+  end
+  it "should be able to get a layout from a URL without caching" do
+    stub_request(:get, "localhost/layout?site=1").to_return(:status => [200, "Success"], :body => "<html>{{test_tag}}</html>")
+    Rails.stub!(:cache).and_return(nil)
+    layout = Cobranding::Layout.get("http://localhost/layout", :params => {:site => 1})
+    layout.evaluate(@context).should == "<html>Woo woo</html>"
+  end
+  it "should generate consistent cache keys" do
+    key_1 = Cobranding::Layout.cache_key("http://localhost/layout", :params => {:a => 1, :b => 2})
+    key_2 = Cobranding::Layout.cache_key("http://localhost/layout", :params => {"a" => "1", "b" => "2"})
+    key_3 = Cobranding::Layout.cache_key("http://localhost/layout?b=2&a=1")
+    key_4 = Cobranding::Layout.cache_key("http://localhost/layout?b=1&a=2")
+    key_5 = Cobranding::Layout.cache_key("http://localhost/layout_2", :params => {:a => 1, :b => 2})
+    key_1.should == key_2
+    key_1.should == key_3
+    key_1.should_not == key_4
+    key_1.should_not == key_5
+  end
+  it "should read a layout from the cache if it is found" do
+    key = Cobranding::Layout.cache_key("http://localhost/layout")
+    cached_layout = Cobranding::Layout.new("<html>Cached</html>")
+    Rails.cache.write(key, cached_layout)
+    layout = Cobranding::Layout.get("http://localhost/layout", :ttl => 300)
+    layout.evaluate(@context).should == "<html>Cached</html>"
+  end
+  it "should not write a layout to the cache if :ttl is not specified" do
+    stub_request(:get, "http://localhost/layout?v=1").to_return(:status => 200, :body => "<html>{{test_tag}}</html>")
+    key = Cobranding::Layout.cache_key("http://localhost/layout", :params => {:v => 1})
+    layout = Cobranding::Layout.get("http://localhost/layout", :params => {:v => 1})
+    layout.evaluate(@context).should == "<html>Woo woo</html>"
+    cached_layout = Rails.cache.read(key)
+    cached_layout.should == nil
+  end
+  it "should expand relative URL's in the HTML based on the request URL" do
+    html = "<a href=\"http://example.com/\"><img src=/logo.gif></a><A HREF='/test2'><IMG SRC=\"/images/new_logo.gif\" id=\"/logo\"></A>"
+    stub_request(:get, "http://localhost/layout").to_return(:status => 200, :body => html)
+    layout = Cobranding::Layout.get("http://localhost/layout")
+    layout.evaluate(@context).should == "<a href=\"http://example.com/\"><img src=http://localhost/logo.gif></a><A HREF='http://localhost/test2'><IMG SRC=\"http://localhost/images/new_logo.gif\" id=\"/logo\"></A>"
+  end
+  it "should expand relative URL's in the HTML based on the :base_url option" do
+    html = "<a href=\"http://example.com/\"><img src=/logo.gif></a><A HREF='/test2'><IMG SRC=\"/images/new_logo.gif\" id=\"/logo\"></A>"
+    stub_request(:get, "http://localhost/layout").to_return(:status => 200, :body => html)
+    layout = Cobranding::Layout.get("http://localhost/layout", :base_url => "https://secure.example.com/")
+    layout.evaluate(@context).should == "<a href=\"http://example.com/\"><img src=https://secure.example.com/logo.gif></a><A HREF='https://secure.example.com/test2'><IMG SRC=\"https://secure.example.com/images/new_logo.gif\" id=\"/logo\"></A>"
+  end
+  it "should process the layout HTML with a block in case it needs to be munged" do
+    html = 'this is <!--#include virtual="test_tag" --> stuff'
+    stub_request(:get, "http://localhost/layout").to_return(:status => 200, :body => html)
+    layout = Cobranding::Layout.get("http://localhost/layout") do |code|
+      code.gsub('i', '!')
+      code.gsub(/<!--#\s*include\s+virtual="([^"]+)"\s*-->/, '{{ \1 }}')
+    end
+    layout.evaluate(@context).should == "this is Woo woo stuff"
+  end
+end

data/spec/persistent_layout_spec.rb ADDED

@@ -0,0 +1,111 @@
+require File.expand_path('../spec_helper', __FILE__)
+describe Cobranding::PersistentLayout do
+  class Cobranding::PersistentLayout::Tester1
+    attr_accessor :src, :url
+    include Cobranding::PersistentLayout
+  end
+  class Cobranding::PersistentLayout::Tester2
+    attr_accessor :layout_src, :layout_url, :layout_url_options
+    include Cobranding::PersistentLayout
+    self.layout_src_attribute = :layout_src
+    self.layout_url_attribute = :layout_url
+    self.layout_url_options_attribute = :layout_url_options
+  end
+  class Cobranding::PersistentLayout::Tester3
+    attr_accessor :src, :url
+    include Cobranding::PersistentLayout
+    self.layout_preprocessor = lambda{|html| html.gsub('s', "$")}
+  end
+  class Cobranding::PersistentLayout::Tester4
+    attr_accessor :src, :url
+    include Cobranding::PersistentLayout
+    self.layout_preprocessor = :replace_i
+    def replace_i (html)
+      html.gsub('i', '!')
+    end
+  end
+  it "should fetch the layout and store the source into default fields" do
+    model = Cobranding::PersistentLayout::Tester1.new
+    model.url = "http://localhost/layout"
+    layout = Cobranding::Layout.new("<html/>")
+    Cobranding::Layout.should_receive(:get).with("http://localhost/layout", {}).and_return(layout)
+    model.fetch_layout
+    model.src.should == layout.src
+    model.layout.should == layout
+  end
+  it "should fetch the layout and store the source into a specified fields" do
+    model = Cobranding::PersistentLayout::Tester2.new
+    model.layout_url = "http://localhost/layout"
+    model.layout_url_options = {"params" => {"v" => 1}}
+    layout = Cobranding::Layout.new("<html/>")
+    Cobranding::Layout.should_receive(:get).with("http://localhost/layout", {"params" => {"v" => 1}}).and_return(layout)
+    model.fetch_layout
+    model.layout_src.should == layout.src
+    model.layout.should == layout
+  end
+  it "should create a layout from the compiled source in the field" do
+    model = Cobranding::PersistentLayout::Tester1.new
+    layout = Cobranding::Layout.new("<html/>")
+    model.src = layout.src
+    model.layout.src.should == layout.src
+    model.layout.object_id.should_not == layout.object_id
+    model.layout.object_id.should == model.layout.object_id
+  end
+  context "fetching with preprocessor" do
+    let(:url){ "http://localhost/layout" }
+    before :each do
+      stub_request(:get, url).to_return(:status => 200, :body => "This is a test")
+    end
+    it "should not invoke a preprocessor if it isn't defined" do
+      model = Cobranding::PersistentLayout::Tester1.new
+      model.url = url
+      model.fetch_layout
+      model.src.should == Cobranding::Layout.new("This is a test").src
+    end
+    it "should use a Proc as the layout preprocessor" do
+      model = Cobranding::PersistentLayout::Tester3.new
+      model.url = url
+      model.fetch_layout
+      model.src.should == Cobranding::Layout.new("Thi$ i$ a te$t").src
+    end
+    it "should use an instance method as the layout preprocessor" do
+      model = Cobranding::PersistentLayout::Tester4.new
+      model.url = url
+      model.fetch_layout
+      model.src.should == Cobranding::Layout.new("Th!s !s a test").src
+    end
+  end
+  context "setting html with preprocessor" do
+    it "should not invoke a preprocessor if it isn't defined" do
+      model = Cobranding::PersistentLayout::Tester1.new
+      model.layout_html = "This is a test"
+      model.src.should == Cobranding::Layout.new("This is a test").src
+    end
+    it "should use a Proc as the layout preprocessor" do
+      model = Cobranding::PersistentLayout::Tester3.new
+      model.layout_html = "This is a test"
+      model.src.should == Cobranding::Layout.new("Thi$ i$ a te$t").src
+    end
+    it "should use an instance method as the layout preprocessor" do
+      model = Cobranding::PersistentLayout::Tester4.new
+      model.layout_html = "This is a test"
+      model.src.should == Cobranding::Layout.new("Th!s !s a test").src
+    end
+  end
+end

data/spec/spec_helper.rb ADDED

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'logger'
+require 'webmock/rspec'
+rails_version = ENV["RAILS_VERSION"] || ">=3.0.5"
+gem 'activesupport', rails_version
+gem 'actionpack', rails_version
+begin
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
+rescue LoadError
+  # simplecov not installed
+end
+WebMock.disable_net_connect!
+require File.expand_path('../../lib/cobranding', __FILE__)
+module Rails
+end
+def Rails.env
+  "test"
+end
+def Rails.cache
+  @cache ||= ActiveSupport::Cache::MemoryStore.new
+end
+def Rails.logger
+  @logger ||= Logger.new(StringIO.new)
+end

metadata ADDED

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: cobranding
+version: !ruby/object:Gem::Version
+  version: 1.2.2
+  prerelease:
+platform: ruby
+authors:
+- Brian Durand
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &70231273526100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70231273526100
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &70231273525080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70231273525080
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70231273524440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70231273524440
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70231273539980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70231273539980
+description: Provides Rails view layouts from an HTTP service.
+email:
+- mdobrota@tribune.com
+- ddpr@tribune.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- License.txt
+- README.rdoc
+- Rakefile
+- lib/cobranding.rb
+- lib/cobranding/helper.rb
+- lib/cobranding/layout.rb
+- lib/cobranding/persistent_layout.rb
+- spec/helper_spec.rb
+- spec/layout_spec.rb
+- spec/persistent_layout_spec.rb
+- spec/spec_helper.rb
+homepage:
+licenses: []
+post_install_message:
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --main
+- README.rdoc
+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.10
+signing_key:
+specification_version: 3
+summary: Provides Rails view layouts from an HTTP service
+test_files: []