pagelime-rack 0.2.1 → 0.2.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YmE2N2I5M2Q4MjJkOTVlMDkwZDllYjliNzgzYTVmOGI2M2E4MTBiNQ==
-  data.tar.gz: !binary |-
-    NWM2ZGFhOTNkNzY4ZGU4M2FmZmFhOWE1MzViZmZmODRiZGFkZmI1MQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    MmZlZjA0YjZiN2UyYmRmYjdmNDY5NDM3MWNhN2I2Njk3ZjE1ODQ4NTU1OWQ2
-    Y2I4Y2UwMDljZTBkZDNhMmU5MzU0YWIwMTdkNThjMTgwZTM0MjMyNzBkYWY0
-    NjA1YmU2ODE0M2Y3ZTRkNDg4NGI5NTM2NTJhMjQ2ZTgwN2Y4Zjk=
-  data.tar.gz: !binary |-
-    ZjYyN2EwNDEwMGIwMWQ0NGZlZGRjNjIyMmY3NTdmNzRlY2Q3NGEyOTQ1MTc4
-    MzZlYTRlZDU0N2Y2OWEyMGNlNTFhZjRiYWE1NDcyNTU4MWExNDMwMmI4M2Jj
-    MjA4NWM1MTY3MjY3OThjM2U3Y2FmNGU2MmNkYTRkNjVmYzU1MjQ=
+SHA1:
+  metadata.gz: 56d7efd14f1b1ae6347a91fd55553809d7597973
+  data.tar.gz: 0c539f4aef56a8359361ab74c68e4077bd680cba
+SHA512:
+  metadata.gz: 8da392f81941b3f5e33fc36da3d68b7bc8b30e3161dfa410b900264b7c56d9c70b02ab1509851a1753b4da324558cec1d53e99eef1c9a758f57b23080f9c8f0f
+  data.tar.gz: 9b1fd19ad4255167cc1bd4d22e22cb6ba4d4fd62fb0c3ed56b52951f461a9c60370ab5396d8747bd08bd1f4837ff92d979f59d331ab823b3d5cbbcef204b9e31

data/README.md

@@ -1,60 +1,88 @@
 Pagelime Rack Plugin
 =====================
 
-Easily add the Pagelime CMS to your rack app.
+Easily add the Pagelime CMS to your Rack app.
 
-Pagelime is a simple CMS service that allows you to define editable regions in your content without installing any software on your site or app. Simply add a class="cms-editable" to any HTML element, and log-in to the Pagelime CMS service to edit your content and images with a nice UI. We host all of the code, content, and data until you publish a page. When you publish a page, we push the content to your site/app via secure FTP or web APIs.
+Pagelime is a simple CMS service that allows you to define editable regions in your content without installing any software on your site or app. 
+Simply add a `class="cms-editable"` to any HTML element, and log-in to the Pagelime CMS service to edit your content and images with a nice UI. 
+We host all of the code, content, and data until you publish a page. 
+When you publish a page, we push the content to your site/app via secure FTP or web APIs.
 
 One line example:
-`<div id="my_content" class="cms-editable">This content is now editable in Pagelime... no code... no databases... no fuss</div>`
+
+    <div id="my_content" class="cms-editable">
+      This content is now editable in Pagelime... no code... no databases... no fuss
+    </div>
 
 Getting Started
 ---------------
 
-Requirements:
+### Requirements
 
-* Pagelime account (either a standalone from pagelime.com or as a Heroku add-on)
+* Pagelime account (either standalone [pagelime.com](http://pagelime.com) or via the [Pagelime Heroku add-on](https://addons.heroku.com/pagelime))
 * Nokogiri gem
 
-#### Step 1: Edit the Gemfile
-edit your `Gemfile` and add
+### Step 1: Install the Pagelime Rack gem
+
+Edit your `Gemfile` and add
 
-`gem "pagelime_rack"`
+    gem "pagelime-rack"
 
 then run
 
-`bundle install`
+    bundle install
 
-### Step 2: Set up your Environment variables
+### Step 2: Setup your Pagelime credentials
 
-`ENV['PAGELIME_ACCOUNT_KEY'] = "..."
-ENV['PAGELIME_ACCOUNT_SECRET'] = "..."
-ENV['PAGELIME_RACK_API_VERSION'] = "1.0"`
+*(Skip if using Heroku add-on)*
 
-### Step 3: Create some editable regions in your views
-like so:
+If you are NOT using the [Pagelime Heroku add-on](https://addons.heroku.com/pagelime), set up an account at [pagelime.com](http://pagelime.com). 
+Make sure that the "Integration Method" for your site on the advanced tab is set to "web services".
 
-`<div id="my_content" class="cms-editable">this is now editable</div>`
+### Step 3: Configure your application
 
-*The ID and the class are required for the CMS to work*
+Set up your Environment variables: *(Skip if using Heroku add-on)*
 
-Sinatra Sample
---------------
+    ENV['PAGELIME_ACCOUNT_KEY'] = "..."
+    ENV['PAGELIME_ACCOUNT_SECRET'] = "..."
+    ENV['PAGELIME_RACK_API_VERSION'] = "1.0"
+
+Alternatively, configure them explicitly:
 
-`require 'sinatra'
-require 'pagelime-rack'
+    Pagelime.configure do |config|
+      config.account_key = "..."
+      config.account_secret = "..."
+      config.api_version = "1.0"
+    end
 
-configure :development do
-	ENV['PAGELIME_ACCOUNT_KEY'] = "..."
-	ENV['PAGELIME_ACCOUNT_SECRET'] = "..."
-	ENV['PAGELIME_RACK_API_VERSION'] = "1.0"
-end
+### Step 4: Make pages editable
 
-use Rack::Pagelime
+Create some editable regions in your views like so:
+
+    <div id="my_content" class="cms-editable">
+      this is now editable
+    </div>
+
+*The ID and the class are required for the CMS to work*
+
+Sinatra Sample
+--------------
 
-get '/page/about' do
-	content_type "text/html"
-  	return "<div id=\"content\" class=\"cms-editable\">Hello World!</div>"
-end`
+    require 'sinatra'
+    require 'pagelime-rack'
+    
+    configure :development do
+      ENV['PAGELIME_ACCOUNT_KEY'] = "..."
+      ENV['PAGELIME_ACCOUNT_SECRET'] = "..."
+      ENV['PAGELIME_RACK_API_VERSION'] = "1.0"
+    end
+    
+    use Rack::Pagelime
+    
+    get '/page/about' do
+      content_type "text/html"
+      return "<div id=\"content\" class=\"cms-editable\">Hello World!</div>"
+    end
+
+Copyright (c) 2013 Pagelime LLC, released under the MIT license
 
-Copyright (c) 2011 Pagelime LLC, released under the MIT license

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/lib/pagelime/s3_client.rb

@@ -37,11 +37,13 @@ module Pagelime
     
       # TODO: check cache (see the rails plugin for info)
     
-      ::Pagelime.logger.debug "PAGELIME CMS PLUGIN: NO SHARED CACHE... loading #{format}"
+      ::Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: NO SHARED CACHE... loading #{format}"
       
       content = request_content("/cms_assets/heroku/#{account_key}/shared-regions.#{format}")
       
-      # puts "PAGELIME CMS PLUGIN: response XML: #{xml_content}"
+      # ::Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: shared XML: #{content}"
+      
+      Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: Shared content: #{content.inspect}"
       
       content
     end
@@ -55,25 +57,32 @@ module Pagelime
     
       # TODO: check cache (see the rails plugin for info)
     
-      Pagelime.logger.debug "PAGELIME CMS PLUGIN: NO '#{page_path}' CACHE... loading #{format}"
+      Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: NO '#{page_path}' CACHE... loading #{format}"
       
       content = request_content("/cms_assets/heroku/#{account_key}/pages#{page_path}.#{format}")
       
+      Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: Content: #{content.inspect}"
+      
       content
     end
     
     def clear(page_path, format = self.class.default_format)
-      Pagelime.logger.warn "#{self.class.name}##{__method__} is not implemented!"
+      Pagelime.logger.warn "PAGELIME CMS RACK PLUGIN: #{self.class.name}##{__method__} is not implemented!"
     end
     
     def clear_shared(format = self.class.default_format)
-      Pagelime.logger.warn "#{self.class.name}##{__method__} is not implemented!"
+      Pagelime.logger.warn "PAGELIME CMS RACK PLUGIN: #{self.class.name}##{__method__} is not implemented!"
     end
     
     private
     
     def request_content(url)
-      http.get(url).body
+      response = http.get(url)
+      
+      Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: S3 response code: #{response.code.inspect}"
+      
+      # only return the body if response code 200-399
+      response.body if (200...400).include?(response.code)
     end
     
     def http

data/lib/pagelime/xml_processor.rb

@@ -12,17 +12,37 @@ module Pagelime
     end
     
     def process_document(html, page_path = false)
+      Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: Document HTML: #{html.inspect}"
+      
       doc = Nokogiri::HTML::Document.parse(html)
       
       # return original HTML if nil returned
-      parse_document(doc, page_path) || html
+      output = parse_document(doc, page_path) || html
+      
+      if html == output
+        Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: Document output: UNCHANGED!"
+      else
+        Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: Document output: #{output.inspect}"
+      end
+      
+      output
     end
     
     def process_fragment(html, page_path = false)
+      Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: Fragment HTML: #{html.inspect}"
+      
       doc = Nokogiri::HTML::DocumentFragment.parse(html)
       
       # return original HTML if nil returned
-      parse_document(doc, page_path) || html
+      output = parse_document(doc, page_path) || html
+      
+      if html == output
+        Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: Fragment output: UNCHANGED!"
+      else
+        Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: Fragment output: #{output.inspect}"
+      end
+      
+      output
     end
     
     private
@@ -31,7 +51,7 @@ module Pagelime
     def parse_document(doc, page_path = false)
       
       unless client.configured?
-        ::Pagelime.logger.warn "PAGELIME CMS PLUGIN: Environment variables not configured"
+        ::Pagelime.logger.warn "PAGELIME CMS RACK PLUGIN: Environment variables not configured"
         return nil
       end
     
@@ -48,7 +68,7 @@ module Pagelime
     
     def patch_regions(editable_regions, xml_content)
     
-      ::Pagelime.logger.debug "PAGELIME CMS PLUGIN: parsing xml"
+      ::Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: parsing xml"
     
       editable_regions.each do |div| 
       
@@ -57,14 +77,13 @@ module Pagelime
         soap      = Nokogiri::XML::Document.parse(xml_content)
         nodes     = soap.css("EditableRegion[@ElementID=\"#{client_id}\"]")
         
-        ::Pagelime.logger.debug "PAGELIME CMS PLUGIN: looking for region: #{client_id}"
-        ::Pagelime.logger.debug "regions found: #{nodes.count}"
+        ::Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: looking for region: #{client_id}"
+        ::Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: regions found: #{nodes.count}"
     
         if nodes.any?
           new_content = nodes[0].css("Html")[0].content
           
-          ::Pagelime.logger.debug "PAGELIME CMS PLUGIN: NEW CONTENT:"
-          ::Pagelime.logger.debug new_content
+          ::Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: NEW CONTENT: #{new_content.inspect}"
           
           if new_content
             # div.content = "Replaced content"

data/lib/rack/pagelime.rb

@@ -11,16 +11,16 @@ module Rack
       @app      = app
       @options  = options
       
-      ::Pagelime.logger.debug  "PAGELIME: Rack Plugin Initialized"
+      ::Pagelime.logger.debug  "PAGELIME CMS RACK PLUGIN: Rack Plugin Initialized"
     end 
 
     def call(env)
 
       status, headers, response = @app.call(env)
 
-      ::Pagelime.logger.debug  "PAGELIME: Headers: #{headers}"
-      ::Pagelime.logger.debug  "PAGELIME: Status: #{status}"
-      ::Pagelime.logger.debug  "PAGELIME: Response: #{response}"
+      ::Pagelime.logger.debug  "PAGELIME CMS RACK PLUGIN: Headers: #{headers}"
+      ::Pagelime.logger.debug  "PAGELIME CMS RACK PLUGIN: Status: #{status}"
+      ::Pagelime.logger.debug  "PAGELIME CMS RACK PLUGIN: Response: #{response}"
 
       if status == 200 && headers["content-type"].include?("text/html")
           
@@ -29,8 +29,8 @@ module Rack
     
         req = Rack::Request.new(env)
 
-        ::Pagelime.logger.debug  "PAGELIME: Processing For Path: #{req.path}"
-        ::Pagelime.logger.debug  "PAGELIME: Processing Body (size:#{body_content.length})"
+        ::Pagelime.logger.debug  "PAGELIME CMS RACK PLUGIN: Processing For Path: #{req.path}"
+        ::Pagelime.logger.debug  "PAGELIME CMS RACK PLUGIN: Processing Body (size:#{body_content.length})"
       
         body = ::Pagelime.html_processor.process_document(body_content, req.path)
 
@@ -40,7 +40,7 @@ module Rack
 
       else
 
-        ::Pagelime.logger.debug  "PAGELIME: Not touching this request"
+        ::Pagelime.logger.debug  "PAGELIME CMS RACK PLUGIN: Not touching this request"
 
         return [status, headers, response]
 

data/pagelime-rack.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "pagelime-rack"
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Emil Anticevic", "Joel Van Horn"]
@@ -37,7 +37,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/eanticev/pagelime-rack"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "2.0.7"
+  s.rubygems_version = "2.0.6"
   s.summary = "Rack Middleware for integrating Pagelime into ruby frameworks"
 
   if s.respond_to? :specification_version then

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pagelime-rack
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Emil Anticevic
@@ -15,84 +15,84 @@ dependencies:
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
   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'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.12'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.8.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.8.4
 description: The Pagelime Rack Middleware will process outgoing HTML, look for editable
@@ -131,17 +131,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Rack Middleware for integrating Pagelime into ruby frameworks