pagelime_rails 0.1.0

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+
+gem "nokogiri"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,59 @@
+Pagelime Rails Plugin
+========
+
+Easily add the Pagelime CMS to your rails 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.
+
+One line example:
+<div id="my_content" class="cms-editable">This content is now editable in Pagelime... no code... no databases... no fuss</div>
+
+
+Getting Started
+=======
+
+Requirements:
+* Pagelime account (either a standalone from www.pagelime.com or as a Heroku add-on)
+* Nokogiri gem
+
+Step 1. 
+If NOT on Heroku, set up a site for your Rails app in Pagelime. Make sure that the "Integration Method" for your site on the advanced tab is set to "web services"
+
+Step 2.
+Install this plugin on your Rails app, or use it as a gem (pagelime-rails)
+
+Step 3.
+Add the plugin routes to your routes.rb configuration:
+
+map.cms_routes
+
+These routes are used by Pagelime to clear any caches after save and publish events on your files.
+
+Step 4.
+For any controller that renders views that you want editable, add the acts_as_cms_editable behavior like so:
+
+class CmsPagesController < ApplicationController
+  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 5.
+Create some editable regions in your views like so:
+<div id="my_content" class="cms-editable">...</div>
+
+The ID is required.
+
+Step 6. (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 %>
+
+Copyright (c) 2011 Pagelime LLC, released under the MIT license

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "pagelime_rails"
+  gem.homepage = "http://github.com/eanticev/pagelime_rails"
+  gem.license = "MIT"
+  gem.summary = "Pagelime Rails Plugin"
+  gem.description = ""
+  gem.email = "eanticev@gmail.com"
+  gem.authors = ["Emil Anticevic"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "pagelime-rails #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/config/routes.rb

@@ -0,0 +1,21 @@
+
+if Rails::VERSION::MAJOR == 2
+
+  ActionController::Routing::Routes.draw do |map|
+    puts "PAGELIME CMS PLUGIN: setting up rails 2 routes"
+    map.connect "pagelime/:action", :controller => :pagelime_receiver_controller  
+  end
+
+elsif Rails::VERSION::MAJOR == 3
+
+  puts "PAGELIME CMS PLUGIN: setting up rails 3 routes"
+    
+  Pagelime::Engine.routes.draw do
+    match 'pagelime/:action' => 'pagelime_receiver'
+  end
+
+  Rails.application.routes.draw do
+    mount Pagelime::Engine => "/"
+  end
+  
+end

data/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require "pagelime_rails" 

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/app/controllers/pagelime_receiver_controller.rb

@@ -0,0 +1,95 @@
+class PagelimeReceiverController < ApplicationController
+  
+  def index
+    render :inline => "working", :status => 200
+  end
+  
+  def after_publish_callback
+    
+  	page_key = Base64.encode64(params[:path])
+    Rails.cache.delete("cms:#{page_key}")
+
+# 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
+  	begin
+  		new_content = fetch_cms_xml(params[:path]);
+  	rescue
+  	end
+=end
+  	
+  	render :inline => "cache cleared", :status => 200
+  	
+  end
+  
+  def after_publish_callback_old
+    
+    # the page_id will come from the request
+    page_id = params[:page_id]
+    
+    # TODO: use the API to get content    
+    uri = URI.parse("http://qa.cms.pagelime.com/API/Account/SOAP/Page.asmx/Get")
+    http = Net::HTTP.new(uri.host, uri.port)
+    # http.use_ssl = true
+    http.open_timeout = 2
+    http.read_timeout = 7
+    # http.set_debug_output $stderr
+    data = {:apiKey => "0fa155c4-9c42-4df6-856a-5cff6e2ff631", :pageId => page_id}.to_json
+    response = http.post(uri.path,data,{"content-type"=>"application/json; charset=utf-8","accept"=>"application/json, text/javascript, */*"})
+
+    page_json = JSON.parse(response.body)
+    page_json = page_json["d"]
+    
+    # try to find existing page
+    page = PagelimePage.find_by_page_id(page_id)
+    if (page)
+      # delete existing content
+      page.editable_areas.destroy
+      page.meta_data.destroy
+    else
+      # if no page is found, create a new one
+      page = PagelimePage.new
+    end
+
+    # set the page data
+    page.page_id = page_id
+    page.path = page_json[:Path]
+    page.title = page_json[:Title]
+    page.date_published = DateTime.now
+    
+    # save the page
+    page.save
+    
+    # for each piece of content
+    for page_content_json in page_json["EditableRegions"]
+      
+      # create the content data
+      page_content = PagelimeContent.new
+      page_content.client_id = page_content_json[:ClientID]
+      page_content.page = page
+      page_content.html = page_content_json[:Html]
+      
+      # save content
+      page_content.save
+      
+    end
+    
+    # for each piece of meta data
+    for metadata_json in page_json["MetaDataJSON"]
+      
+      # create the content data
+      page_metadata = PagelimeMetaData.new
+      page_metadata.name = metadata_json[0]
+      page_metadata.content = metadata_json[1]
+      page_metadata.page = page
+      
+      # save content
+      page_metadata.save
+      
+    end
+    
+    # respond with an OK status or CREATED status
+    render :status => 200
+    
+  end
+  
+end

data/lib/app/helpers/pagelime_helper.rb

@@ -0,0 +1,20 @@
+require 'nokogiri'
+require 'openssl'
+require 'base64'
+require	'cgi'
+require 'net/http'
+
+module PagelimeHelper
+  
+  def cms_content(&block)
+    # the block contents loaded into a variable
+    input_content = capture(&block)
+    page_path = request.path
+    html = cms_process_html_block(page_path,input_content)
+    # output the final content
+    concat(html)
+    # raw capture(&block) + "<div>hello world</div>"
+    # raw "BLA!";
+  end
+  
+end

data/lib/engine.rb

@@ -0,0 +1,10 @@
+
+module Pagelime
+  class Engine < Rails::Engine
+    engine_name :pagelime
+    # paths["config/routes"] << 'config/routes.rb'
+    initializer "pagelime.initialize" do |app|
+      initialize_pagelime_plugin
+    end
+  end
+end

data/lib/pagelime_rails.rb

@@ -0,0 +1,160 @@
+# Pagelime
+
+puts "PAGELIME CMS PLUGIN: included"
+
+def pagelime_environment_configured?
+  ENV['PAGELIME_ACCOUNT_KEY'] != nil &&
+  ENV['PAGELIME_ACCOUNT_SECRET'] != nil &&
+  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
+	
+end
+
+def cms_process_html_block(page_path=nil, html="")
+
+    begin
+
+      unless pagelime_environment_configured?
+        puts "PAGELIME CMS PLUGIN: Environment variables not configured"
+        return html
+      end
+  
+      # 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
+    
+    rescue
+      
+      # error
+      puts "PAGELIME CMS PLUGIN: Error rendering block"
+      
+      # comment below to disable debug
+      raise
+      
+      return html
+      
+    end
+	  
+end
+
+module PagelimeControllerExtensions
+
+	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
+      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"
+      end
+		end
+	end
+
+end
+
+def initialize_pagelime_plugin
+  
+  puts "PAGELIME CMS PLUGIN: initializing"
+  
+  # add dependencies to load paths
+  %w{ models controllers helpers }.each do |dir|
+    path = File.join(File.dirname(__FILE__), 'app', dir)
+    $LOAD_PATH << path
+    
+    if Rails::VERSION::MAJOR == 2
+      ActiveSupport::Dependencies.load_paths << path
+      ActiveSupport::Dependencies.load_once_paths.delete(path)
+    elsif Rails::VERSION::MAJOR == 3
+      ActiveSupport::Dependencies.autoload_paths << path
+      ActiveSupport::Dependencies.autoload_once_paths.delete(path)
+    end
+  end
+  
+  # wire controller extensions
+  ActionController::Base.extend PagelimeControllerExtensions
+  
+  # wire helper
+  require "app/helpers/pagelime_helper" 
+  ActionView::Base.send :include, PagelimeHelper
+  
+end
+
+# start plugin 
+if Rails::VERSION::MAJOR == 2
+  require "routing_extensions"
+  # below is not needed in Rails 2 as you can use the map.cms_routes from the routing_extensions
+  # require File.join(File.dirname(__FILE__), "/../config/routes.rb")
+  initialize_pagelime_plugin
+elsif Rails::VERSION::MAJOR == 3
+  require "engine"
+end

data/lib/routing_extensions.rb

@@ -0,0 +1,13 @@
+module Pagelime #:nodoc:
+  module Routing #:nodoc:
+    module MapperExtensions
+      def cms_routes
+        @set.add_route("/pagelime/:action", {:controller => "pagelime_receiver"})
+      end
+    end
+  end
+end
+
+if Rails::VERSION::MAJOR == 2
+  ActionController::Routing::RouteSet::Mapper.send :include, Pagelime::Routing::MapperExtensions
+end

data/lib/tasks/pagelime.rake

@@ -0,0 +1,19 @@
+# desc "Explaining what the task does"
+# task :pagelime do
+#   # Task goes here
+# end
+
+namespace :db do
+  namespace :migrate do
+    description = "Migrate the database through scripts in vendor/plugins/pagelime/lib/db/migrate"
+    description << "and update db/schema.rb by invoking db:schema:dump."
+    description << "Target specific version with VERSION=x. Turn off output with VERBOSE=false."
+ 
+    desc description
+    task :pagelime => :environment do
+      ActiveRecord::Migration.verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
+      ActiveRecord::Migrator.migrate("vendor/plugins/pagelime/lib/db/migrate/", ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+      Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
+    end
+  end
+end

data/pagelime_rails.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{pagelime_rails}
+  s.version = "0.1.0"
+
+  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.description = %q{}
+  s.email = %q{eanticev@gmail.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "Gemfile",
+    "MIT-LICENSE",
+    "README",
+    "Rakefile",
+    "VERSION",
+    "config/routes.rb",
+    "init.rb",
+    "install.rb",
+    "lib/app/controllers/pagelime_receiver_controller.rb",
+    "lib/app/helpers/pagelime_helper.rb",
+    "lib/engine.rb",
+    "lib/pagelime_rails.rb",
+    "lib/routing_extensions.rb",
+    "lib/tasks/pagelime.rake",
+    "pagelime_rails.gemspec",
+    "rails/init.rb",
+    "test/pagelime_test.rb",
+    "test/test_helper.rb",
+    "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/eanticev/pagelime_rails}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{Pagelime Rails Plugin}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/rails/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require "pagelime_rails"

data/test/pagelime_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class PagelimeTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification 
+name: pagelime_rails
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Emil Anticevic
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-09 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: nokogiri
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  name: jeweler
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id004
+description: ""
+email: eanticev@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- Gemfile
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- config/routes.rb
+- init.rb
+- install.rb
+- lib/app/controllers/pagelime_receiver_controller.rb
+- lib/app/helpers/pagelime_helper.rb
+- lib/engine.rb
+- lib/pagelime_rails.rb
+- lib/routing_extensions.rb
+- lib/tasks/pagelime.rake
+- pagelime_rails.gemspec
+- rails/init.rb
+- test/pagelime_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/eanticev/pagelime_rails
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Pagelime Rails Plugin
+test_files: []
+