cobranding 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2d581381b003911325c74d39156ac4a57e92aab
-  data.tar.gz: 5cd1ea7db2de4c6bdc6c0322e557d6fe42103ddc
+  metadata.gz: 6f291bfa3856e3e76f1fc6ab2618ae4400f3f271
+  data.tar.gz: c28bdccd62fa0b946537c065ac920f42fd3006ee
 SHA512:
-  metadata.gz: 34f67921e280300d25755e29c483e5fdc08bb102694424eae71978fd88629a090eadcef44483ddc299e9ce2895f54a363389f29e192dec8d2e6ae96bae6b2148
-  data.tar.gz: 2193656f961cfc9260719884503b5f3e8dc6450a1a8d85a451c1a89dcd477a83dc0f252ef49e0414f91c4f3234ae5030086a31b7deed697a8fa290998757cadd
+  metadata.gz: a1f27079073f1fecd0aad1c542eb61ec1623c3a5920ba5c61b3ae4df4a208a5223a84f190847182a9a5f463d635a010432e13765a148abdc332f4b209d1da1e9
+  data.tar.gz: ac4ccf60123df1aedbff68697f9bc330f9657bd90451a3c4792c20227eeb1096d1da3b4b4f294f2b66eadccb2c3f9a6ed7fa991c93cdf12831aa8321a87913aa

data/.gitignore

@@ -1,7 +1,6 @@
-Gemfile.lock
-*.swm
-*.swn
-*.swo
-*.swp
+/Gemfile.lock
+/gemfiles/*.lock
+/pkg
+/.bundle
+*.sw[mnop]
 *.gem
-pkg

data/Appraisals

@@ -0,0 +1,20 @@
+# Install gems for all appraisal definitions:
+#
+#     $ appraisal install
+#
+# To run tests on different versions:
+#
+#     $ appraisal activerecord_x.x rspec spec
+
+[
+  [ '3.2', '~> 3.2.0' ],
+  [ '4.0', '~> 4.0.0' ],
+  [ '4.1', '~> 4.1.0' ],
+  [ '4.2', '~> 4.2.0' ],
+].each do |ver_name, ver_req|
+  # Note: for the rake task to work, these definition names must be the same as the corresponding
+  # filename produced in "gemfiles/", i.e. all characters must be in this set: [A-Za-z0-9_.]
+  appraise "rails_#{ver_name}" do
+    gem 'actionpack', ver_req
+  end
+end

data/README.rdoc

@@ -4,11 +4,11 @@ This gem allows you too pull marked up HTML from a URL and use it as a layout in
 
 == Fetching the layout
 
-To fetch the layout from a service, you can cal
+To fetch the layout from a service, you can call
 
   Cobranding::Layout.get(url, options)
 
-Where +url+ and +options+ are values passed to +SimpleHttpClient+. Additional options available are
+Where +url+ and +options+ are values passed to +RestClient+. Additional options available are
 
 * base_url: set the base url for expanding any relative URLs in the markup
 * method: set to :post to perform a POST instead of a GET request
@@ -67,3 +67,7 @@ If the tag includes a block, it will only be called if there was an error evalua
 == Persisting
 
 If you have layouts that don't need to be real time, you can persist them to a data store and update them asynchronously via a background job. You simply need to include Cobranding::PersistentLayout in your model. To render the layout, you can then pass in model.layout to the cobranding_layout helper instead of a URL.
+
+== Limitations
+
+The result of Cobranding::Helper#cobranding_layout (or Cobranding::Layout#evaluate) will be a string with UTF-8 encoding, regardless of the encoding reported by the server. If you need the result to be a different encoding, you can call force_encoding on the result.

data/Rakefile

@@ -1 +1,21 @@
 require 'bundler/gem_tasks'
+require 'bundler/setup'
+require 'pathname'
+
+# Note: if you get this error: "Bundler could not find compatible versions for gem ..."
+# try deleting Gemfile.lock (usually happens when switching branches).
+
+task default: :appraise_all
+
+task :appraise_all do
+  success_map = {}
+  Pathname.glob('gemfiles/*.gemfile').each do |f|
+    appraise_def = f.basename('.gemfile').to_s
+    success = system('appraisal', appraise_def, 'rspec', 'spec')
+    success_map[appraise_def] = success
+  end
+  puts "\n===== Test Summary ====="
+  success_map.each do |appraise_def, success|
+    puts "#{appraise_def}: #{success ? 'no failures (but check pending)' : 'failed'}"
+  end
+end

data/cobranding.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cobranding/version'
 Gem::Specification.new do |spec|
   spec.name          = 'cobranding'
-  spec.version       = Cobranding::VERSION
+  spec.version       = Cobranding::VERSION.dup  # dup for 1.9's rubygems
   spec.authors       = ['Brian Durand', 'Milan Dobrota']
   spec.email         = ['mdobrota@tribpub.com']
   spec.summary       = 'Provides Rails view layouts from an HTTP service'
@@ -16,11 +16,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'actionpack', '>= 3.0.0'
-  spec.add_runtime_dependency 'rest-client', '>= 0'
+  spec.add_runtime_dependency 'actionpack', '>= 3.2', '< 4.3'
+  spec.add_runtime_dependency 'rest-client', '~> 1.6'
 
-  spec.add_development_dependency 'rspec', '~> 2.8.0'
-  spec.add_development_dependency 'webmock', '~> 1.7.7'
+  spec.add_development_dependency 'rspec', '~> 2.99'
+  spec.add_development_dependency 'webmock', '~> 1.21.0'
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'appraisal'
 end

data/gemfiles/rails_3.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "actionpack", "~> 3.2.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "actionpack", "~> 4.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "actionpack", "~> 4.1.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "actionpack", "~> 4.2.0"
+
+gemspec :path => "../"

data/lib/cobranding/layout.rb

@@ -1,3 +1,6 @@
+# coding: utf-8
+# NOTE this file should be in utf-8 encoding so #evaluate generates a string with
+# this encoding. Otherwise on ruby 1.9 it'll be US-ASCII.
 require 'erb'
 require 'digest/md5'
 require 'rest-client'
@@ -10,7 +13,7 @@ module Cobranding
     UNQUOTED_RELATIVE_URL = /(<\w+\s((src)|(href))=)\/(.*?)(>|(\s[^>]*?>))/i
     
     class << self
-      # Get the layout HTML from a service. The options can be any of the options accepted by SimpleHttpClient
+      # Get the layout HTML from a service. The options can be any of the options accepted by RestClient
       # or +:base_url+. Any relative URLs found in the HTML will be expanded to absolute URLs using either the
       # +:base_url+ option or the +url+ as the base.
       #
@@ -172,6 +175,8 @@ module Cobranding
         suffix = options[:suffix] if options
         suffix = "_for_cobranding" unless prefix or suffix
         evaluator = Object.new
+        # "src" is erb code, which contains the code `force_encoding(__ENCODING__)`.
+        # __ENCODING__ is the current file's encoding (see magic comment above).
         eval <<-EOS
           def evaluator.evaluate
             #{src}

data/lib/cobranding/version.rb

@@ -1,3 +1,3 @@
 module Cobranding
-  VERSION = '1.2.3'.freeze
+  VERSION = '1.3.0'.freeze
 end

data/spec/helper_spec.rb

@@ -30,7 +30,7 @@ describe Cobranding::Helper do
   
   before :each do
     cache = ActiveSupport::Cache::MemoryStore.new
-    Rails.stub!(:cache).and_return(cache)
+    Rails.stub(:cache).and_return(cache)
   end
   
   it "should render a layout in a view with a Layout" do

data/spec/layout_spec.rb

@@ -9,7 +9,7 @@ describe Cobranding::Layout do
     end
     
     cache = ActiveSupport::Cache::MemoryStore.new
-    Rails.stub!(:cache).and_return(cache)
+    Rails.stub(:cache).and_return(cache)
   end
 
   it "should be able to evaluate a template from HTML" do
@@ -84,14 +84,14 @@ describe Cobranding::Layout do
   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>")
+    stub_request(:post, "localhost/layout").with(:body => {"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)
+    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
@@ -148,4 +148,12 @@ describe Cobranding::Layout do
     end
     layout.evaluate(@context).should == "this is Woo woo stuff"
   end
+
+  it "returns a UTF-8 encoded string" do
+    layout = Cobranding::Layout.new("<html>Test</html>")
+    expect(layout.evaluate(@context).encoding.name).to eq 'UTF-8'
+    unless Gem::Requirement.new('~> 1.9.1').satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+      warn "Please also run this test on ruby 1.9 (#{File.basename(__FILE__)}:#{__LINE__})."
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,9 +1,6 @@
-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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cobranding
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
 - Brian Durand
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-26 00:00:00.000000000 Z
+date: 2015-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -17,56 +17,62 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.3'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '2.99'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '2.99'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: 1.21.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: 1.21.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +101,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides Rails view layouts from an HTTP service.
 email:
 - mdobrota@tribpub.com
@@ -103,11 +123,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- Appraisals
 - Gemfile
 - License.txt
 - README.rdoc
 - Rakefile
 - cobranding.gemspec
+- gemfiles/rails_3.2.gemfile
+- gemfiles/rails_4.0.gemfile
+- gemfiles/rails_4.1.gemfile
+- gemfiles/rails_4.2.gemfile
 - lib/cobranding.rb
 - lib/cobranding/helper.rb
 - lib/cobranding/layout.rb