pagelime-rack 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 070b0b0b5836c9268cce47357e443507f8c9f22e
-  data.tar.gz: 464f86690db69dab770bb8f799724d7b86ec20a7
+  metadata.gz: 962d445dd40119959ee05bf58956c5e1f35fcdf2
+  data.tar.gz: ffacd3eb81878110192113a19baaf5c8c900bce4
 SHA512:
-  metadata.gz: e38aef90d7a2b86405c1845d37dac9192f58df779700906886e745f7da40baee2f5bca36e5508cd30d5429ea47e4b7b3586ea6b953147a2deb011bd2dca54c77
-  data.tar.gz: f35d169ad130f39f357e8aaa9d1f8e2b57be4ebe8a6ab83cf61c88e44d01effb98f9d01d04a7c0c2fef4d6c7aaad038b86e32683e38b65953fa9dd69f17fc2ea
+  metadata.gz: 1035b00408158783bd980eaf86e8a23842eb3d582ef119f17ae5cb25bc44ddd044c514d6b721a87106a34265830fd817268856c2d346e85dc425797d9f4c5fbe
+  data.tar.gz: 93d89782ea417292705d445866eb11d920a6785c4b892f51cc9c478c6fd8aac4f0226967505ba6f346ca9cc50a5b299f37d34b342f25e333b4d3904c39e43e4c

data/README.md

@@ -43,16 +43,17 @@ Make sure that the "Integration Method" for your site on the advanced tab is set
 
 Set up your Environment variables: *(Skip if using Heroku add-on)*
 
-    ENV['PAGELIME_ACCOUNT_KEY'] = "..."
-    ENV['PAGELIME_ACCOUNT_SECRET'] = "..."
+    ENV['PAGELIME_ACCOUNT_KEY']      = "..."
+    ENV['PAGELIME_ACCOUNT_SECRET']   = "..."
     ENV['PAGELIME_RACK_API_VERSION'] = "1.0"
 
-Alternatively, configure them explicitly:
+Optionally, enable caching:
 
     Pagelime.configure do |config|
-      config.account_key = "..."
-      config.account_secret = "..."
-      config.api_version = "1.0"
+      # object that responds to `fetch` and `delete`
+      config.cache = ...
+      # options passed to `fetch(key, options = {}, &block)`
+      config.cache_fetch_options = { ... }
     end
 
 ### Step 4: Make pages editable
@@ -65,6 +66,19 @@ Create some editable regions in your views like so:
 
 *The ID and the class are required for the CMS to work*
 
+### Step 5: Edit your pages!
+
+#### For Heroku users
+
+If you're using the Pagelime Heroku add-on, go to the Heroku admin for your app and under the "Resources" tab you will see the Pagelime add-on listed. 
+Click on the add-on name and you will be redirected to the Pagelime CMS editor. 
+From there you can edit any page in your Rack app!
+
+#### For Pagelime.com users
+
+If you have a standalone Pagelime account, simply go to [pagelime.com](http://pagelime.com) and edit your site as usual (see Step 2). 
+
+
 Sinatra Sample
 --------------
 
@@ -72,8 +86,8 @@ Sinatra Sample
     require 'pagelime-rack'
     
     configure :development do
-      ENV['PAGELIME_ACCOUNT_KEY'] = "..."
-      ENV['PAGELIME_ACCOUNT_SECRET'] = "..."
+      ENV['PAGELIME_ACCOUNT_KEY']      = "..."
+      ENV['PAGELIME_ACCOUNT_SECRET']   = "..."
       ENV['PAGELIME_RACK_API_VERSION'] = "1.0"
     end
     
@@ -81,7 +95,7 @@ Sinatra Sample
     
     get '/page/about' do
       content_type "text/html"
-      return "<div id=\"content\" class=\"cms-editable\">Hello World!</div>"
+      return '<div id="content" class="cms-editable">Hello World!</div>'
     end
 
 Copyright (c) 2013 Pagelime LLC, released under the MIT license

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.3.0

data/lib/pagelime-rack.rb

@@ -1,9 +1,10 @@
 require_relative 'pagelime'
-require_relative 'pagelime/s3_client'
-require_relative 'pagelime/xml_processor'
+require_relative 'pagelime/clients/xml_s3_storage'
+require_relative 'pagelime/clients/xml_processor'
 require_relative 'rack/pagelime'
 
 Pagelime.configure do |config|
-  config.client_class     = Pagelime::S3Client
-  config.processor_class  = Pagelime::XmlProcessor
+  #config.cache = ...
+  config.storage    = Pagelime::Clients::XmlS3Storage.new
+  config.processor  = Pagelime::Clients::XmlProcessor.new
 end

data/lib/pagelime.rb

@@ -1,4 +1,6 @@
 require_relative 'pagelime/configuration'
+require_relative 'pagelime/storage_engine'
+require_relative 'pagelime/cache_engine'
 
 module Pagelime
   module ClassMethods
@@ -7,20 +9,28 @@ module Pagelime
       config.configure(&block)
     end
     
-    def config
-      @config ||= Configuration.new
+    def process_page(html, page_path)
+      config.processor.process_document(storage, html, page_path)
     end
     
-    def logger
-      config.logger
+    def process_region(html, page_path)
+      config.processor.process_fragment(storage, html, page_path)
+    end
+    
+    def storage
+      @storage ||= StorageEngine.new(config, cache)
     end
     
-    def client
-      config.client
+    def cache
+      @cache ||= CacheEngine.new(config)
     end
     
-    def processor
-      config.processor
+    def config
+      @config ||= Configuration.new
+    end
+    
+    def logger
+      config.logger
     end
   end
   

data/lib/pagelime/cache_engine.rb

@@ -0,0 +1,68 @@
+require 'base64'
+
+module Pagelime
+  class CacheEngine
+    
+    def initialize(config)
+      @config = config
+    end
+    
+    ### CMS-specific methods
+    
+    def fetch_path(page_path, &block)
+      cache_key = generate_region_cache_key(page_path)
+      
+      fetch(cache_key, fetch_options, &block)
+    end
+    
+    def fetch_shared(&block)
+      cache_key = static_shared_cache_key
+      
+      fetch(cache_key, fetch_options, &block)
+    end
+    
+    def clear_page(page_path)
+      cache_key = generate_region_cache_key(page_path)
+      
+      delete cache_key
+    end
+    
+    def clear_shared
+      cache_key = static_shared_cache_key
+      
+      delete cache_key
+    end
+    
+    ### Generic cache methods
+    
+    def fetch(key, options = {}, &block)
+      if @config.cache
+        @config.cache.fetch(key, fetch_options, &block)
+      else
+        yield
+      end
+    end
+    
+    def delete(key)
+      @config.cache.delete(key) if @config.cache
+    end
+    
+    private
+    
+    def generate_region_cache_key(page_path)
+      if @config.generate_region_cache_key.respond_to? :call
+        @config.generate_region_cache_key.call(page_path)
+      else
+        "pagelime:cms:page:#{Base64.encode64(page_path)}"
+      end
+    end
+    
+    def static_shared_cache_key
+      @config.static_shared_cache_key || "pagelime:cms:shared"
+    end
+    
+    def fetch_options
+      @config.cache_fetch_options || {}
+    end
+  end
+end

data/lib/pagelime/clients/xml_processor.rb

@@ -0,0 +1,93 @@
+require "nokogiri"
+
+module Pagelime
+  module Clients
+    class XmlProcessor
+      
+      def process_document(storage, 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
+        output = parse_document(storage, 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(storage, 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
+        output = parse_document(storage, 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
+      
+      def parse_document(storage, doc, page_path = false)
+        editable_content  = storage.fetch_path(page_path)
+        shared_content    = storage.fetch_shared
+        
+        unless editable_content || shared_content
+          ::Pagelime.logger.warn "PAGELIME CMS RACK PLUGIN: Content not returned from storage"
+          return nil
+        end
+      
+        # use nokogiri to replace contents
+        editable_regions  = doc.css(".cms-editable")
+        shared_regions    = doc.css(".cms-shared")
+        
+        patch_regions editable_regions, editable_content
+        patch_regions shared_regions, shared_content
+          
+        doc.to_html
+      end
+      
+      def patch_regions(editable_regions, xml_content)
+      
+        ::Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: parsing xml"
+      
+        editable_regions.each do |div| 
+        
+          # Grab content ID
+          content_id = div["id"]
+          soap      = Nokogiri::XML::Document.parse(xml_content)
+          nodes     = soap.css("EditableRegion[@ElementID=\"#{content_id}\"]")
+          
+          ::Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: looking for region: #{content_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 RACK PLUGIN: NEW CONTENT: #{new_content.inspect}"
+            
+            if new_content
+              # div.content = "Replaced content"
+              div.replace new_content
+            end
+          end
+        
+        end
+    
+      end
+      
+    end
+  end
+end

data/lib/pagelime/clients/xml_s3_storage.rb

@@ -0,0 +1,55 @@
+require "base64"
+require "net/http"
+
+module Pagelime
+  module Clients
+    class XmlS3Storage
+      
+      def initialize(options = {})
+        @options = {
+          :account_key    => ENV['PAGELIME_ACCOUNT_KEY'],
+          :account_secret => ENV['PAGELIME_ACCOUNT_SECRET'],
+          :api_version    => ENV['PAGELIME_RACK_API_VERSION']
+        }.merge(options)
+      end
+      
+      def fetch_shared
+      
+        Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: NO SHARED CACHE... loading XML"
+        
+        content = request_content("/cms_assets/heroku/#{@options[:account_key]}/shared-regions.xml")
+        
+        Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: Shared content: #{content.inspect}"
+        
+        content
+      end
+      
+      def fetch_path(page_path)
+        
+        Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: NO '#{page_path}' CACHE... loading XML"
+        
+        content = request_content("/cms_assets/heroku/#{@options[:account_key]}/pages#{page_path}.xml")
+        
+        Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: Content: #{content.inspect}"
+        
+        content
+      end
+      
+      private
+      
+      def request_content(url)
+        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.to_f)
+      end
+      
+      def http
+        @http ||= Net::HTTP::new('s3.amazonaws.com', 80)
+      end
+      
+    end
+  end
+end

data/lib/pagelime/configuration.rb

@@ -4,38 +4,20 @@ module Pagelime
   class Configuration
     
     # only allow getter access unless using configure block
-    attr_accessor :account_key, :account_secret, :api_version, :client_class, :processor_class, :logger
-    attr_reader :client, :processor
+    attr_accessor :logger, :storage, :cache, :processor
+    attr_accessor :generate_region_cache_key, :static_shared_cache_key, :cache_fetch_options
     
     # pass in a configure block to write new values
     def initialize(defaults = {}, &block)
-      @account_key     = ENV['PAGELIME_ACCOUNT_KEY']
-      @account_secret  = ENV['PAGELIME_ACCOUNT_SECRET']
-      @api_version     = ENV['PAGELIME_RACK_API_VERSION']
-      @logger          = Logger.new(STDOUT)
+      @logger = Logger.new(STDOUT)
       
       configure(&block)
     end
     
     def configure(&block)
-      if block_given?
-        # pass self to configuration block
-        yield(self)
-        
-        # recreate instances in case classes were updated
-        rebuild!
-      end
+      yield(self) if block_given?
       
       self
     end
-    
-    def rebuild!
-      if client_class.nil? || processor_class.nil?
-        raise "You must specify client_class and processor_class"
-      end
-      
-      @client     = client_class.new(account_key, account_secret, api_version)
-      @processor  = processor_class.new(@client)
-    end
   end
 end

data/lib/pagelime/storage_engine.rb

@@ -0,0 +1,23 @@
+module Pagelime
+  class StorageEngine
+    
+    attr_reader :cache
+    
+    def initialize(config, cache_engine)
+      @config = config
+      @cache  = cache_engine# || CacheEngine.new(config)
+    end
+    
+    def fetch_path(page_path)
+      @cache.fetch_path page_path do
+        @config.storage.fetch_path(page_path)
+      end
+    end
+    
+    def fetch_shared
+      @cache.fetch_shared do
+        @config.storage.fetch_shared
+      end
+    end
+  end
+end

data/lib/rack/pagelime.rb

@@ -32,7 +32,7 @@ module Rack
         ::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)
+        body = ::Pagelime.process_page(body_content, req.path)
 
         headers['content-length'] = body.length.to_s
 

data/pagelime-rack.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "pagelime-rack"
-  s.version = "0.2.3"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Emil Anticevic", "Joel Van Horn"]
-  s.date = "2013-09-05"
+  s.date = "2013-09-11"
   s.description = "The Pagelime Rack Middleware will process outgoing HTML, look for editable areas, and replace the content with the appropriate HTML from the Pagelime CDN and cache it in memory if possible."
   s.email = "emil@pagelime.com"
   s.extra_rdoc_files = [
@@ -26,9 +26,11 @@ Gem::Specification.new do |s|
     "VERSION",
     "lib/pagelime-rack.rb",
     "lib/pagelime.rb",
+    "lib/pagelime/cache_engine.rb",
+    "lib/pagelime/clients/xml_processor.rb",
+    "lib/pagelime/clients/xml_s3_storage.rb",
     "lib/pagelime/configuration.rb",
-    "lib/pagelime/s3_client.rb",
-    "lib/pagelime/xml_processor.rb",
+    "lib/pagelime/storage_engine.rb",
     "lib/rack/pagelime.rb",
     "pagelime-rack.gemspec",
     "test/helper.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pagelime-rack
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Emil Anticevic
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-05 00:00:00.000000000 Z
+date: 2013-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -114,9 +114,11 @@ files:
 - VERSION
 - lib/pagelime-rack.rb
 - lib/pagelime.rb
+- lib/pagelime/cache_engine.rb
+- lib/pagelime/clients/xml_processor.rb
+- lib/pagelime/clients/xml_s3_storage.rb
 - lib/pagelime/configuration.rb
-- lib/pagelime/s3_client.rb
-- lib/pagelime/xml_processor.rb
+- lib/pagelime/storage_engine.rb
 - lib/rack/pagelime.rb
 - pagelime-rack.gemspec
 - test/helper.rb

data/lib/pagelime/s3_client.rb

@@ -1,93 +0,0 @@
-require "base64"
-require "net/http"
-
-module Pagelime
-  class S3Client
-    
-    module ClassMethods
-      def default_format
-        :xml
-      end
-    end
-    
-    extend ClassMethods
-    
-    attr_reader :account_key, :account_secret, :api_version
-    
-    def initialize(account_key, account_secret, api_version)
-      # reference config object to ensure we have the latest credentials, etc
-      @account_key    = account_key
-      @account_secret = account_secret
-      @api_version    = api_version
-      
-      #raise "WARNING: Account key, secret, and API version were not specified!" unless configured?
-    end
-    
-    def configured?
-      !(account_key.nil?)# || account_secret.nil? || api_version.nil?)
-    end
-    
-    # def cms_api_signature(req)
-      # secret    = account_secret
-      # signature = Base64.encode64(OpenSSL::HMAC.digest('sha1', secret, req).to_s)
-      # return signature
-    # end
-    
-    def fetch_shared(format = self.class.default_format)
-    
-      # TODO: check cache (see the rails plugin for info)
-    
-      ::Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: NO SHARED CACHE... loading #{format}"
-      
-      content = request_content("/cms_assets/heroku/#{account_key}/shared-regions.#{format}")
-      
-      # ::Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: shared XML: #{content}"
-      
-      Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: Shared content: #{content.inspect}"
-      
-      content
-    end
-    
-    def fetch(page_path, format = self.class.default_format)
-      
-      # TODO: Should element_ids be used anywhere?
-      
-      # TODO: Should page_key be used anywhere?
-      page_key = Base64.encode64(page_path)
-    
-      # TODO: check cache (see the rails plugin for info)
-    
-      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 "PAGELIME CMS RACK PLUGIN: #{self.class.name}##{__method__} is not implemented!"
-    end
-    
-    def clear_shared(format = self.class.default_format)
-      Pagelime.logger.warn "PAGELIME CMS RACK PLUGIN: #{self.class.name}##{__method__} is not implemented!"
-    end
-    
-    private
-    
-    def request_content(url)
-      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.to_f)
-    end
-    
-    def http
-      @http ||= Net::HTTP::new('s3.amazonaws.com', 80)
-    end
-    
-  end
-end

data/lib/pagelime/xml_processor.rb

@@ -1,99 +0,0 @@
-require "nokogiri"
-
-module Pagelime
-  class XmlProcessor
-    
-    attr_reader :client
-    attr_reader :format
-    
-    def initialize(client)
-      @client = client
-      @format = :xml
-    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
-      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
-      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
-    
-    # options = { :page_path => nil, :html => "", :fragment => true }
-    def parse_document(doc, page_path = false)
-      
-      unless client.configured?
-        ::Pagelime.logger.warn "PAGELIME CMS RACK PLUGIN: Environment variables not configured"
-        return nil
-      end
-    
-      # use nokogiri to replace contents
-      editable_regions  = doc.css(".cms-editable")
-      shared_regions    = doc.css(".cms-shared")
-      
-      patch_regions editable_regions, client.fetch(page_path, format)
-      patch_regions shared_regions, client.fetch_shared(format)
-        
-      return doc.to_html
-      
-    end
-    
-    def patch_regions(editable_regions, xml_content)
-    
-      ::Pagelime.logger.debug "PAGELIME CMS RACK PLUGIN: parsing xml"
-    
-      editable_regions.each do |div| 
-      
-        # Grab client ID
-        client_id = div["id"]
-        soap      = Nokogiri::XML::Document.parse(xml_content)
-        nodes     = soap.css("EditableRegion[@ElementID=\"#{client_id}\"]")
-        
-        ::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 RACK PLUGIN: NEW CONTENT: #{new_content.inspect}"
-          
-          if new_content
-            # div.content = "Replaced content"
-            div.replace new_content
-          end
-        end
-      
-      end
-  
-    end
-    
-  end
-end