pagelime-rails 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa1a0e99acbcdfb19c39cbfb2691e14939026d5f
-  data.tar.gz: 2ed9b3b3d00bc9c357b1b500197f57256152de17
+  metadata.gz: 58e60826a5397d0cc87cb048bc64e4b33318298d
+  data.tar.gz: 1983331f41658deadeafa5f413bbfa164522adf3
 SHA512:
-  metadata.gz: c3070f871611ac2b907772bae1c329c2dec404eed073f82682c3c578d3790b0771752d6b79c0d50606da747d0381a1366055694eff1ba1e80bfb59001e3ce2b5
-  data.tar.gz: fb2ac21c1ff0b9be04c823d2fd1c5f74b29ff218db25a37493aef2632df77bc48d6aa13c0d152b6391a49080ae90949847b4ccf7083f19e1d11ca751407dd0a5
+  metadata.gz: 3212b2942a8744db1ff6553519a4c81fff4ff67e4df855177e785c4aab05b5e23a514a594526cc1574c1cf5b065ce512da33dff4edc51945283139f8da83097f
+  data.tar.gz: 8e6af18dbcee6f3325bae95a75f9682c55adc57c2a89272f5065bfa7cc0a230a5f0252d0afefcaf3ccd698a49ec9a1bb384c48e727e7cf7697fe70fb859fcbf1

data/Gemfile

@@ -2,7 +2,7 @@ source "http://rubygems.org"
 # Add dependencies required to use your gem here.
 # Example:
 
-gem 'pagelime-rack', '>= 0.4.4'
+gem 'pagelime-rack', '>= 0.4.6'
 gem 'rails', '>= 2.3'
 
 # Add dependencies to develop your gem here.

data/README.md

@@ -3,16 +3,31 @@ 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. 
+Pagelime is a simple CMS service that allows you to define editable regions in your pages without installing any software on your website 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, simple 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.
+When you publish a page, the PageLime CMS pushes the content to your website via secure FTP or an API. 
+Using the Rails plugin, we pull the new content into your app dynamically via an API.
 
-One line example:
+### Quick Start (2 lines of code!)
 
-    <div id="my_content" class="cms-editable">
-      This content is now editable in Pagelime... no code... no databases... no fuss
-    </div>
+First, add the `cms-editable` class and an `id` to make content editable:
+
+```html
+<div id="my_content" class="cms-editable">
+  This content is now editable in Pagelime... no code... no databases... no fuss
+</div>
+```
+
+Second, add `acts_as_cms_editable` to your controller to display the latest content:
+
+```ruby
+class CmsPagesController < ApplicationController
+  acts_as_cms_editable
+end
+```
+
+Done!
 
 Getting Started
 ---------------
@@ -24,25 +39,35 @@ Getting Started
 
 ### Step 1: Install the Pagelime Rails gem
 
-#### For Rails 2
+#### For Rails 3
 
-Edit your `config/environment.rb` file and add:
+Edit your `Gemfile` and add
 
-    config.gem "pagelime-rails"
+```ruby
+gem "pagelime-rack"
+gem "pagelime-rails"
+```
 
 then run
 
-    rake gems:install
+```bash
+bundle install
+```
 
-#### For Rails 3
+#### For Rails 2 (not officially supported)
 
-Edit your `Gemfile` and add
+Edit your `config/environment.rb` file and add:
 
-    gem "pagelime-rails"
+```ruby
+config.gem "pagelime-rack"
+config.gem "pagelime-rails"
+```
 
 then run
 
-    bundle install
+```bash
+rake gems:install
+```
 
 ### Step 2: Setup your Pagelime credentials
 
@@ -55,38 +80,45 @@ Make sure that the "Integration Method" for your site on the advanced tab is set
 
 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
+```ruby
+class CmsPagesController < ApplicationController
+  # attach the cms behavior to the controller
+  acts_as_cms_editable
 
-You can pass an `:except` parameter just like with a filter like so:
+  def index
+  end
+end
+```
 
-    acts_as_cms_editable :except => :index
+You can pass an `:except` parameter just like with a filter like so:
 
-Optionally, enable caching and logging:
+```ruby
+acts_as_cms_editable :except => :index
+```
 
-    Pagelime.configure do |config|
-      # object that responds to `fetch` and `delete`
-      config.cache = Rails.cache
-      # options passed to `fetch(key, options = {}, &block)`
-      config.cache_fetch_options = { :expires_in => 1.year }
-      # any standard logger
-      config.logger = Rails.logger
-    end
+Caching and logging are automatically setup using your Rails configuration. 
+You can specify custom caching and logging by adding the following to an initializer file.
 
-#### Only for Rails 2.3.x
+```ruby
+Pagelime.configure do |config|
 
-Add the plugin routes to your `config/routes.rb` configuration:
+  # object that responds to `fetch` and `delete`
+  config.cache = Rails.cache
+  
+  # options passed to `fetch(key, options = {}, &block)`
+  config.cache_fetch_options = { :expires_in => 1.year }
+  
+  # any standard logger
+  config.logger = Rails.logger
+  
+end
+```
 
-    map.cms_routes
+*It is highly recommended that you enable server caching to reduce latency on each request when retrieving CMS content. [MemCachier](https://www.memcachier.com/) has a great [Heroku addon](https://addons.heroku.com/memcachier) for caching if you don't have caching configured.*
 
-These routes are used by Pagelime to clear any caches after save and publish events on your files.
+#### Rack Middleware
 
-*Rails 3 does not need this statement, as the plugin will behave as an engine*
+The `Rack::Pagelime` middleware is inserted before `Rack::ConditionalGet` to retrieve CMS content before HTTP caching is performed.
 
 #### Additional configuration options
 
@@ -96,19 +128,23 @@ These routes are used by Pagelime to clear any caches after save and publish eve
 
 Create some editable regions in your views like so:
 
-    <div id="my_content" class="cms-editable">
-      this is now editable
-    </div>
+```html
+<div id="my_content" class="cms-editable">
+  this is now editable
+</div>
+```
 
-*The ID and the class are required for the CMS to work*
+*The `ID` and the `class` are required for the CMS to work*
 
 Optionally: 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 %>
+```rhtml
+<% cms_content do %>
+  <div id="my_content" class="cms-editable">
+    hello world
+  </div>
+<% end %>
+```
 
 ### Step 5: Edit your pages!
 

data/VERSION

@@ -1 +1 @@
-0.4.3
+0.4.4

data/lib/pagelime/rails.rb

@@ -17,11 +17,24 @@ module Pagelime
       end
       
       def configure_pagelime!
+        assets = ::Rails.application.config.assets
+        
         ::Pagelime.configure do |config|
           config.toggle_processing    = "per_request"
           config.logger               = ::Rails.logger
-          config.cache                = ::Rails.cache
           config.cache_fetch_options  = { :expires_in => 1.year }
+          config.cache                = ::Rails.cache
+          
+          if assets.enabled == true
+            
+            # fallback on asset logger if available
+            config.logger ||= assets.logger if assets.logger != false
+            
+            # fallback on asset cache_store if available
+            config.cache ||= ActiveSupport::Cache.lookup_store(assets.cache_store) if assets.cache_store != false
+            
+          end
+          
         end
       end
     end

data/pagelime-rails.gemspec

@@ -2,14 +2,15 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: pagelime-rails 0.4.4 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pagelime-rails"
-  s.version = "0.4.3"
+  s.version = "0.4.4"
 
   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-25"
+  s.date = "2014-02-11"
   s.description = ""
   s.email = "emil@pagelime.com"
   s.extra_rdoc_files = [
@@ -39,25 +40,25 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/eanticev/pagelime_rails"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "2.0.6"
+  s.rubygems_version = "2.1.5"
   s.summary = "Pagelime Rails Plugin"
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<pagelime-rack>, [">= 0.4.4"])
+      s.add_runtime_dependency(%q<pagelime-rack>, [">= 0.4.6"])
       s.add_runtime_dependency(%q<rails>, [">= 2.3"])
       s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
       s.add_development_dependency(%q<jeweler>, [">= 1.6.4"])
     else
-      s.add_dependency(%q<pagelime-rack>, [">= 0.4.4"])
+      s.add_dependency(%q<pagelime-rack>, [">= 0.4.6"])
       s.add_dependency(%q<rails>, [">= 2.3"])
       s.add_dependency(%q<bundler>, [">= 1.0.0"])
       s.add_dependency(%q<jeweler>, [">= 1.6.4"])
     end
   else
-    s.add_dependency(%q<pagelime-rack>, [">= 0.4.4"])
+    s.add_dependency(%q<pagelime-rack>, [">= 0.4.6"])
     s.add_dependency(%q<rails>, [">= 2.3"])
     s.add_dependency(%q<bundler>, [">= 1.0.0"])
     s.add_dependency(%q<jeweler>, [">= 1.6.4"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pagelime-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Emil Anticevic
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-25 00:00:00.000000000 Z
+date: 2014-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pagelime-rack
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: 0.4.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: 0.4.6
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -113,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.1.5
 signing_key: 
 specification_version: 4
 summary: Pagelime Rails Plugin