pagelime_rails 0.1.1 → 0.1.2

data/Heroku.md

@@ -1,4 +1,80 @@
 Pagelime CMS Addon
 =====================
 
-The CMS add-on enables the Pagelime CMS for your app, and allows your team to edit content on your Heroku app without commiting new code, modifying the database, or impacting the release process. 
+The CMS add-on enables the Pagelime CMS for your app, and allows your team to edit content on your Heroku app without commiting new code, modifying the database, or impacting the release process.
+
+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.
+
+In your views, make any element editable just by adding a CSS class:
+`<div id="my_content" class="cms-editable">This content is now editable in Pagelime... no code... no databases... no fuss</div>`
+
+Getting Started
+---------------
+
+### Step 1.
+Require the **pagelime_rails** gem
+
+#### For Rails 2
+edit your `config/environment.rb` file and add:
+
+`config.gem "pagelime_rails"`
+
+then run
+
+`rake gems:install`
+
+#### For Rails 3
+edit your `Gemfile` and add
+
+`gem "pagelime_rails"`
+
+then run
+
+`bundle install`
+
+### Step 2. (Only for Rails 2.3.X)
+Add the plugin routes to your `config/routes.rb` configuration:
+
+`map.cms_routes`
+
+These routes are used by Pagelime to clear any caches after save and publish events on your files.
+
+*Rails 3 does not need this statement, as the plugin will behave as an engine*
+
+### Step 3.
+For any controller that renders views that you want editable, add the acts_as_cms_editable behavior like so:
+
+    class CmsPagesController < ApplicationController
+        # attach the cms behavior to the controller
+        acts_as_cms_editable
+
+        def index
+        end
+    end
+
+You can pass an `:except` parameter just like with a filter like so:
+
+`acts_as_cms_editable :except => :index`
+
+### Step 4.
+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*
+
+### Step 5. (OPTIONAL)
+If you don't want to have your entire controller CMS editable for some reason, you can sorround areas in your view with a code block like so:
+
+	<% cms_content do %>
+		<div id="my_content" class="cms-editable">hello world</div>
+	<% end %>
+	
+### Step 6.
+Add the pagelime addon to your app from the command line:
+
+`heroku addons:add pagelime`
+
+How it works under the hood
+---------------------------
+Pagelime is a cloud CMS. It provides a simple WYSIWYG editing interface for your pages, and pushes updated content and images to your app.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/app/controllers/pagelime_receiver_controller.rb

@@ -8,6 +8,7 @@ class PagelimeReceiverController < ApplicationController
     
   	page_key = Base64.encode64(params[:path])
     Rails.cache.delete("cms:#{page_key}")
+    Rails.cache.delete("cms:shared")
 
 # don't do the prefetch below, as the page isn't done publishing (mySQL transaction hasn't completed) at the point when this gets called  	
 =begin

data/lib/pagelime_rails.rb

@@ -8,44 +8,89 @@ def pagelime_environment_configured?
   ENV['PAGELIME_HEROKU_API_VERSION']
 end
 
-def fetch_cms_xml(page_path)
-
-	page_key = Base64.encode64(page_path)
-	xml_content = Rails.cache.fetch("cms:#{page_key}", :expires_in => 15.days) do
-	  puts "PAGELIME CMS PLUGIN: NO CACHE... loading xml"
-		# set input values
-		key = ENV['PAGELIME_ACCOUNT_KEY']
-		secret = ENV['PAGELIME_ACCOUNT_SECRET']
-		api_version = ENV['PAGELIME_HEROKU_API_VERSION']
-		req = "apiKey=#{key}&path=#{CGI.escape(page_path)}"
-		
-		# generate API signature
-		signature = Base64.encode64("#{OpenSSL::HMAC.digest('sha1',secret,req)}")
-		headers = {'Signature' => signature}
-		
-		puts "PAGELIME CMS PLUGIN: SIGNATURE:" + signature
-	
-		# get the url that we need to post to
-		http = Net::HTTP::new('qa.cms.pagelime.com',80)
-		
-		# send the request
-		response = http.request_post("/api/heroku/#{api_version}/content.asmx/PageContent", req, headers)
-
-		# cache the file
-		# File.open("#{Rails.root}/tmp/test.cms", 'w') {|f| f.write(response.body) }
-		
-		xml_content = response.body
-		
-		xml_content
-	end
-	
-	return xml_content
-	
+def cms_api_signature(req)
+  secret = ENV['PAGELIME_ACCOUNT_SECRET']
+  signature = Base64.encode64("#{OpenSSL::HMAC.digest('sha1',secret,req)}")
+  return signature
+end
+
+def fetch_cms_shared_xml
+  xml_content = Rails.cache.fetch("cms:shared", :expires_in => 1.year) do
+    puts "PAGELIME CMS PLUGIN: NO SHARED CACHE... loading xml"
+    # set input values
+    key = ENV['PAGELIME_ACCOUNT_KEY']
+    
+    # get the url that we need to post to
+    http = Net::HTTP::new('s3.amazonaws.com',80)
+    
+    # send the request
+    response = http.get("/cms_assets_qa/heroku/#{key}/shared-regions.xml")
+    
+    # puts "PAGELIME CMS PLUGIN: response XML: #{response.body}"
+    
+    xml_content = response.body
+    
+    xml_content
+  end
+  
+  return xml_content
+  
+end
+
+def fetch_cms_xml(page_path, element_ids)
+
+  page_key = Base64.encode64(page_path)
+  xml_content = Rails.cache.fetch("cms:#{page_key}", :expires_in => 1.year) do
+    puts "PAGELIME CMS PLUGIN: NO '#{page_path}' CACHE... loading xml"
+    # set input values
+    key = ENV['PAGELIME_ACCOUNT_KEY']
+    
+    # get the url that we need to post to
+    http = Net::HTTP::new('s3.amazonaws.com',80)
+    
+    response = http.get("/cms_assets_qa/heroku/#{key}/pages#{page_path}.xml")
+    
+    # puts "PAGELIME CMS PLUGIN: response XML: #{response.body}"
+    
+    xml_content = response.body
+    
+    xml_content
+  end
+  
+  return xml_content
+  
+end
+
+def cms_process_html_block_regions(editable_regions, xml_content)
+
+    editable_regions.each do |div| 
+    
+    # Grab client ID
+    client_id = div["id"]
+    
+    puts "PAGELIME CMS PLUGIN: parsing xml"
+    soap = Nokogiri::XML::Document.parse(xml_content)
+    puts "PAGELIME CMS PLUGIN: looking for region: #{client_id}"
+    xpathNodes = soap.css("EditableRegion[@ElementID=\"#{client_id}\"]")
+    puts "regions found: #{xpathNodes.count}"
+    if (xpathNodes.count > 0)
+      new_content = xpathNodes[0].css("Html")[0].content()
+      
+      puts "PAGELIME CMS PLUGIN: NEW CONTENT:"
+      puts new_content
+      
+      if (new_content)
+        # div.content = "Replaced content"
+        div.replace new_content
+      end
+    end
+    
+    end
+
 end
 
 def cms_process_html_block(page_path=nil, html="")
 
-    begin
 
       unless pagelime_environment_configured?
         puts "PAGELIME CMS PLUGIN: Environment variables not configured"
@@ -54,71 +99,44 @@ def cms_process_html_block(page_path=nil, html="")
   
       # use nokogiri to replace contents
       doc = Nokogiri::HTML::DocumentFragment.parse(html) 
-      doc.css("div.cms-editable").each do |div| 
-        
-  		# Grab client ID
-  		client_id = div["id"]
-  
-  		# Load pagelime content
-  		xml_content = fetch_cms_xml(page_path)
-  		
-  		puts "PAGELIME CMS PLUGIN: parsing xml"
-  		soap = Nokogiri::XML::Document.parse(xml_content)
-  		puts "PAGELIME CMS PLUGIN: looking for region: #{client_id}"
-  		xpathNodes = soap.css("EditableRegion[@ElementID=\"#{client_id}\"]")
-  		puts "regions found: #{xpathNodes.count}"
-  		if (xpathNodes.count > 0)
-  			new_content = xpathNodes[0].css("Html")[0].content()
-  			
-  			puts "PAGELIME CMS PLUGIN: NEW CONTENT:"
-  			puts new_content
-  			
-  			if (new_content)
-  				# div.content = "Replaced content"
-  				div.replace new_content
-  			end
-  		end
-        
-      end
-      
-      return doc.to_html
+    editable_regions = doc.css(".cms-editable")
+    shared_regions = doc.css(".cms-shared")
     
-    rescue
-      
-      # error
-      puts "PAGELIME CMS PLUGIN: Error rendering block"
-      
-      # comment below to disable debug
-      raise
-      
-      return html
+    region_client_ids = Array.new
       
+    editable_regions.each do |div| 
+    region_client_ids.push div["id"]
     end
-	  
+    
+    cms_process_html_block_regions(editable_regions, fetch_cms_xml(page_path,region_client_ids))
+    cms_process_html_block_regions(shared_regions,fetch_cms_shared_xml())
+      
+      return doc.to_html
+    
 end
 
 module PagelimeControllerExtensions
 
-	def acts_as_cms_editable(opts=Hash.new)
-		after_filter :cms_process_rendered_body, :except => opts[:except]
-		include InstanceMethods
-	end
+  def acts_as_cms_editable(opts=Hash.new)
+    after_filter :cms_process_rendered_body, :except => opts[:except]
+    include InstanceMethods
+  end
 
-	module InstanceMethods
-		def cms_process_rendered_body
+  module InstanceMethods
+    def cms_process_rendered_body
       puts "PAGELIME CMS PLUGIN: Processing response body"
-		  if pagelime_environment_configured?
-  			# response contents loaded into a variable
-  			input_content = response.body
-  			page_path = request.path
-  			html = cms_process_html_block(page_path,input_content)
-  			# output the final content
-  			response.body = html
-			else
-        puts "PAGELIME CMS PLUGIN: Environment variables not configured"
+      if pagelime_environment_configured?
+        # response contents loaded into a variable
+        input_content = response.body
+        page_path = request.path
+        html = cms_process_html_block(page_path,input_content)
+        # output the final content
+        response.body = html
+      else
+      puts "PAGELIME CMS PLUGIN: Environment variables not configured"
       end
-		end
-	end
+    end
+  end
 
 end
 

data/pagelime_rails.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pagelime_rails}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Emil Anticevic"]
-  s.date = %q{2012-01-09}
+  s.date = %q{2012-01-10}
   s.description = %q{}
   s.email = %q{eanticev@gmail.com}
   s.files = [

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: pagelime_rails
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Emil Anticevic
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-09 00:00:00 -08:00
+date: 2012-01-10 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency